Retrieve a payout intent action

GET

/payout-intent-actions/{id}

Fetches a single payout intent action by its unique identifier. A payout intent action represents a concrete attempt to disburse funds against a payout intent (e.g. a payout to a bank account, or an offline cash payout). The action must belong to the authenticated entity — the entity_id from the bearer token is automatically applied as a scoping condition, so callers cannot retrieve actions 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 action was found and returned successfully.

Bodyapplication/json

🟠400

🟠401

🟠404

Request Example

Shell

JavaScript

Java

Swift

curl --location '/payout-intent-actions/01J3KQZM0000000000000000CD' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Success

{
    "message": "Payout intent action retrieved successfully",
    "status": "success",
    "data": {
        "id": "01J3KQZM0000000000000000CD",
        "entity_id": "01HQZR2BKPFQ8MXJVT3G7LWNA",
        "account_id": "01HQZR2BKPFQ8MXJVT3G7LWNE",
        "currency": "NGN",
        "amount": 500000,
        "payout_intent_id": "01J3KQZM0000000000000000AB",
        "client_meta": {
            "invoice_id": "inv-88213"
        },
        "system_meta": null,
        "narration": "Vendor reimbursement for Q3 logistics",
        "client_reference": "payout-action-ref-20260812-001",
        "counterparty": {
            "email": "jane.doe@example.com",
            "first_name": "Jane",
            "last_name": "Doe",
            "account_number": "0123456789",
            "bank_code": "044",
            "bank_name": "Access Bank"
        },
        "type": "payout",
        "status": "successful",
        "status_reason": null,
        "provider_code": "flutterwave-ng",
        "applicable_fee": 5000,
        "source_amount": 500000,
        "source_currency": "NGN",
        "exchange_rate": 1,
        "conversion_fee": null,
        "quote_id": null,
        "occurrence_number": null,
        "scheduled_for": null,
        "created": 1754524800000,
        "updated": 1754524800000
    }
}

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

List payout intent actions

Create a payout intent