List payout intent actions

GET

/payout-intent-actions

Returns a paginated list of payout intent actions belonging to the authenticated entity, ordered newest first. A payout intent action represents a concrete disbursement attempt (a single payout or cash-offline collection) carried out against a payout intent, including the resolved counterparty, fee, and provider used. Use the optional query parameters to filter by parent payout intent, counterparty, or status. 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 intent actions retrieved successfully. Returns a page of payout intent actions and pagination metadata.

Bodyapplication/json

🟠400

🟠401

Request Example

Shell

JavaScript

Java

Swift

curl --location '/payout-intent-actions?payout_intent_id=01HQZR2BKPFQ8MXJVT3G7LWNE&counterparty_id=01HQZR2BKPFQ8MXJVT3G7LWNF&status=successful&cursor=01HQZR2BKPFQ8MXJVT3G7LWNA&limit=20' \
--header 'Authorization: Bearer <token>'

Response Example

200 - First page — more results available

{
    "message": "Payout intent actions retrieved successfully",
    "status": "success",
    "data": [
        {
            "id": "01HQZR2BKPFQ8MXJVT3G7LWNZ",
            "entity_id": "01HQZR2BKPFQ8MXJVT3G7LWNA",
            "account_id": "01HQZR2BKPFQ8MXJVT3G7LWNC",
            "currency": "NGN",
            "amount": 250000,
            "payout_intent_id": "01HQZR2BKPFQ8MXJVT3G7LWNE",
            "client_meta": {
                "department": "finance"
            },
            "system_meta": {},
            "narration": "Vendor reimbursement for Q3 services",
            "client_reference": "action-ref-20260806-001",
            "counterparty": {
                "id": "01HQZR2BKPFQ8MXJVT3G7LWNF",
                "account_number": "0123456789",
                "bank_code": "044",
                "bank_name": "Access Bank",
                "email": "vendor@example.com"
            },
            "type": "payout",
            "status": "successful",
            "status_reason": null,
            "provider_code": "flutterwave-payout",
            "applicable_fee": 500,
            "source_amount": 250000,
            "source_currency": "NGN",
            "exchange_rate": 1,
            "conversion_fee": 0,
            "quote_id": null,
            "occurrence_number": null,
            "scheduled_for": null,
            "created": 1754524800000,
            "updated": 1754524800000
        }
    ],
    "meta": {
        "pagination": {
            "cursor": "01HQZR2BKPFQ8MXJVT3G7LWNZ",
            "has_more": true
        }
    }
}

Modified at 2026-09-30 00:29:30

Create a payout intent action

Retrieve a payout intent action