Retrieves a CollectionOrder resource.
This endpoint allows you to retrieve the summary of a single collection order.
### Response fields
| Field | Description |
|-------|-------------|
| collection_order_id | Unique identifier of the collection order |
| status | Current status of the collection order |
| flow_id | The ID of the flow assigned to this collection order |
| flow_step | The current step number in the flow |
| amount | Total amount in cents |
| status_datetime | Date and time of the last status change |
| created_datetime | Date and time the collection order was created |
| debtor_number | Identifier for the debtor |
| payment_reference | Identifier for the payment request |
### Collection Order Status
The status of a collection order can be one of the following:
- active — The collection order is active and in progress
- paid — Full amount has been paid
- agreed — A payment agreement has been reached
- pause — The collection order is paused
- cancel — The collection order has been cancelled
- withdraw — The collection order has been withdrawn
- processing — The collection order is being processed
- settlement — A settlement has been reached
- merged — The collection order has been merged with another
- payment_scheduled — A payment has been scheduled
- end — The collection order has ended
For full details, use the /v3/collection_orders/{id}/detail endpoint.
curl -X GET "/v3/collection_orders/{id}" \
-H "Authorization: Bearer $POM_API_DOCUMENTATION_API_KEY"Authorization
AuthorizationstringheaderrequiredOAuth 2.0 client credentials Grant
Parameters
idstringpathrequiredCollectionOrder identifier
Response
CollectionOrder resource
collection_order_idintegerstatusstringflow_idinteger | nullflow_stepinteger | nullamountinteger | nullstatus_datetimestring<date-time> | nullcreated_datetimestring<date-time> | nulldebtor_numberstring | nullpayment_referencestring | null
{
"collection_order_id": 0,
"status": "string",
"flow_id": 0,
"flow_step": 0,
"amount": 0,
"status_datetime": "2026-01-15T09:30:00Z",
"created_datetime": "2026-01-15T09:30:00Z",
"debtor_number": "string",
"payment_reference": "string"
}