Updates the CollectionOrder resource.
This endpoint updates collection orders identified by debtor_number + payment_reference instead of by their internal {id}. It accepts the same request body as PATCH /v3/collection_orders/{id} — all fields are optional and only fields present in the request body are updated.
### Identifying the collection order (query parameters)
Provide both query parameters. Together they scope the update to your account:
| Parameter | Behaviour |
|---------------------|------------------------------------------------------------------|
| debtor_number | The debtor number of the collection order(s) to update. |
| payment_reference | The payment reference of the collection order(s) to update. |
When the pair matches more than one collection order, the update is applied to every matching order. When no collection order matches, the endpoint responds with 404. Omitting either parameter responds with 422.
All other behaviour like status transitions and their side effects, flow switching, variables, invoices is identical to PATCH /v3/collection_orders/{id}.
curl -X PATCH "/v3/collection_orders?debtor_number=&payment_reference=" \
-H "Authorization: Bearer $POM_API_DOCUMENTATION_API_KEY" \
-H "Content-Type: application/merge-patch+json" \
-d '{
"status": "active",
"flow_id": 100,
"flow_step": 1,
"flow_datetime": "2025-06-01 09:00:00",
"first_name": "John",
"last_name": "Doe",
"email": "[email protected]",
"secondary_email": "[email protected]",
"phone_number": "+31612345678",
"secondary_phone_number": "+31612345679",
"street_name": "Van Coulsterweg",
"house_number": "2A",
"zip_code": "2952CB",
"city": "Alblasserdam",
"country": "Nederland",
"concerning": "Rent April 2025",
"label": "Example label",
"batch_id": "Batch_2025-05-01",
"client_request_id": "req_1234567890",
"username": "John Doe",
"return_url": "https://example.nl/payment",
"company_name": "Collect BV",
"date_of_birth": "1990-01-15",
"gender": "M",
"personal_identification_number": "199001011234",
"language": "nl",
"payment_modules": [
"ideal"
],
"variables": {
"variable1": "qwerty",
"variable500": "asdfg"
}
}'Authorization
AuthorizationstringheaderrequiredOAuth 2.0 client credentials Grant
Parameters
debtor_numberstringqueryrequiredDebtor number identifying the collection order(s) to update. Required together with
payment_reference.payment_referencestringqueryrequiredPayment reference identifying the collection order(s) to update. Required together with
debtor_number.
Body
The updated CollectionOrder resource
statusenum<string> | nullOne of:activepaidagreedpausecancelwithdrawprocessingsettlementpayment_promisedmergedpayment_scheduledendflow_idinteger | nullflow_stepinteger | nullflow_datetimestring<date-time> | nullfirst_namestring | nulllast_namestring | nullemailstring<email> | nullsecondary_emailstring<email> | nullphone_numberstring | nullsecondary_phone_numberstring | nullstreet_namestring | nullhouse_numberstring | nullzip_codestring | nullcitystring | nullcountrystring | nullsecondary_street_namestring | nullsecondary_house_numberstring | nullsecondary_zip_codestring | nullsecondary_citystring | nullsecondary_countrystring | nullconcerningstring | nulllabelstring | nullbatch_idstring | nullclient_request_idstring | nullusernamestring | nullreturn_urlstring | nullcompany_namestring | nulldate_of_birthstring | nullgenderenum<string> | nullOne of:MFpersonal_identification_numberstring | nulllanguagestring | nullpayment_modulesstring[] | nullvariablesmap of stringinvoicesCollectionOrderInvoiceInput-collection_order.write[]
Response
CollectionOrder resource updated
{}