List payout intents

GET

/payout-intents

Returns a paginated list of payout intents belonging to the authenticated entity, ordered newest first. A payout intent represents a request to move funds out of one of your accounts, optionally routed through a maker-checker approval workflow before it is dispatched. Use the optional query parameters to filter by status or source account. Pagination is cursor-based: pass the cursor value from the previous response's meta.pagination.cursor field to fetch the next page. When has_more is false, you have reached the end of the list.

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 ********************

Query Params

Responses

🟢200

application/json

Payout intents retrieved successfully. Returns a page of payout intents and pagination metadata.

Bodyapplication/json

🟠400

🟠401

Request Example

Shell

JavaScript

Java

Swift

curl --location '/payout-intents?status=successful&account_id=01HQZR2BKPFQ8MXJVT3G7LWNE&cursor=01HQZR2BKPFQ8MXJVT3G7LWNA&limit=20' \
--header 'Authorization: Bearer <token>'

Response Example

200 - First page — more results available

{
    "message": "Payout intents retrieved successfully",
    "status": "success",
    "data": [
        {
            "id": "01HQZR2BKPFQ8MXJVT3G7LWNE",
            "entity_id": "01HQZR2BKPFQ8MXJVT3G7LWNA",
            "account_id": "01HQZR2BKPFQ8MXJVT3G7LWNC",
            "currency": "NGN",
            "amount": 250000,
            "client_reference": "payout-ref-20260806-001",
            "client_meta": {
                "department": "finance"
            },
            "system_meta": {},
            "status": "successful",
            "reason": "Vendor reimbursement for Q3 services",
            "supporting_documents": [],
            "status_reason": null,
            "status_code": null,
            "type": "single",
            "maker_checker_approver_group_id": "01HQZR2BKPFQ8MXJVT3G7LWNF",
            "fully_approved_at": 1754524800000,
            "created": 1754524800000,
            "updated": 1754524800000
        }
    ],
    "meta": {
        "pagination": {
            "cursor": "01HQZR2BKPFQ8MXJVT3G7LWNE",
            "has_more": true
        }
    }
}

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

Create a payout intent

Retrieve a payout intent