Retrieve a payout intent

GET

/payout-intents/{id}

Fetches a single payout intent by its unique identifier. The payout intent must belong to the authenticated entity — the entity_id from the bearer token is automatically applied as a scoping condition, so callers cannot retrieve payout intents belonging to other entities.

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

Responses

🟢200

application/json

The payout intent was found and returned successfully.

Bodyapplication/json

🟠400

🟠401

🟠404

Request Example

Shell

JavaScript

Java

Swift

curl --location '/payout-intents/01J3KQZM0000000000000000AB' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Success

{
    "message": "Payout intent retrieved successfully",
    "status": "success",
    "data": {
        "id": "01J3KQZM0000000000000000AB",
        "entity_id": "01HQZR2BKPFQ8MXJVT3G7LWNA",
        "account_id": "01HQZR2BKPFQ8MXJVT3G7LWNE",
        "currency": "NGN",
        "amount": 500000,
        "client_reference": "payout-ref-20260812-001",
        "client_meta": {
            "invoice_id": "inv-88213"
        },
        "system_meta": null,
        "status": "pending",
        "reason": "Vendor reimbursement for Q3 logistics",
        "supporting_documents": [
            {
                "title": "Vendor invoice",
                "type": "invoice",
                "url": "https://files.example.com/invoices/inv-88213.pdf"
            }
        ],
        "status_reason": null,
        "status_code": null,
        "type": "single",
        "maker_checker_approver_group_id": null,
        "fully_approved_at": null,
        "schedule": null,
        "action_template": null,
        "next_run_at": null,
        "occurrence_count": null,
        "last_fired_at": null,
        "created": 1754524800000,
        "updated": 1754524800000
    }
}

Modified at 2026-09-28 15:32:42

List payout intents

Edit a payout intent