Retrieves a Settlement resource.
This endpoint returns the settlement currently attached to a collection order.
If the collection order has no settlement yet, the response is 404. The same status is returned when the collection order does not exist or does not belong to the authenticated client — the response body distinguishes the two cases.
### Response fields
| Field | Description |
|-------|-------------|
| settlement_id | Unique identifier of the settlement. |
| collection_order_id | Identifier of the collection order this settlement belongs to. |
| settlement_profile_id | Identifier of the profile used to create the settlement. |
| status | Current status of the settlement: active, lapsed, done, or cancelled. |
| created_at | When the settlement was created. |
| terms | Ordered list of terms with term_number, amount, status, send_at, due_date. |
### Term statuses
A term may be in one of: pending, sent, paid, cancelled, failed, bounced, expired, processing.
curl -X GET "/v3/collection_orders/{id}/settlement" \
-H "Authorization: Bearer $POM_API_DOCUMENTATION_API_KEY"Authorization
AuthorizationstringheaderrequiredOAuth 2.0 client credentials Grant
Parameters
idstringpathrequiredSettlement identifier
Response
Settlement resource
settlement_idintegerUnique identifier of the settlement.
collection_order_idintegerIdentifier of the collection order this settlement belongs to.
settlement_profile_idintegerIdentifier of the settlement profile used.
statusstringCurrent status of the settlement.
created_atstring<date-time>Date and time when the settlement was created.
termsSettlementTermOutput-settlement.read[]
{
"settlement_id": 1234,
"collection_order_id": 999,
"settlement_profile_id": 42,
"status": "active",
"created_at": "2026-05-20T12:00:00+02:00",
"terms": [
{
"term_number": 1,
"amount": 10000,
"status": "pending",
"send_at": "2026-06-01T09:00:00+02:00",
"due_date": "2026-06-15"
}
]
}