Edit a payout intent

Updates mutable fields on an existing payout intent, such as its reason, supporting_documents, client_meta, and client_reference. Only intents in a new or pending state can be edited — once a payout intent action has been created for the intent (i.e. it has moved past these states), attempting to edit it returns an error. Fields omitted from the request body are left unchanged; only fields explicitly supplied are updated.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Body Params application/jsonRequired

Examples

application/json

The payout intent was successfully updated with the supplied fields and the full, current representation of the intent is returned.

Bodyapplication/json

curl --location --request PATCH '/payout-intents/01J3KQZM0000000000000000AB' \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "reason": "Vendor settlement for invoice #4521", "client_reference": "payout_ref_20250805_0091", "supporting_documents": [ { "title": "Signed invoice", "type": "invoice", "url": "https://files.example.com/invoices/4521.pdf" } ], "client_meta": { "batch_id": "batch_20250805_01", "department": "finance" } }'

{ "message": "Payout intent updated successfully", "status": "success", "data": { "id": "01J3KQZM0000000000000000AB", "entity_id": "01J3KQ0000000000000000ENTT", "account_id": "01J3KQABC0000000000000000X", "currency": "NGN", "amount": 500000, "client_reference": "payout_ref_20250805_0091", "client_meta": { "batch_id": "batch_20250805_01", "department": "finance" }, "status": "new", "reason": "Vendor settlement for invoice #4521", "supporting_documents": [ { "title": "Signed invoice", "type": "invoice", "url": "https://files.example.com/invoices/4521.pdf" } ], "type": "single", "created": 1754388720000, "updated": 1754392100000 } }

Request

Responses