Retrieve a bulk payout intent action batch

GET

/bulk-payout-intent-actions/{id}

Fetches a single bulk payout intent action batch by its unique identifier. A bulk payout intent action batch represents a group of individual payout intent actions submitted together against a bulk payout intent, along with the per-item validation and queuing outcome for each submission. The batch must belong to the authenticated entity — the entity_id from the bearer token is automatically applied as a scoping condition, so callers cannot retrieve batches 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 bulk payout intent action batch was found and returned successfully.

Bodyapplication/json

🟠401

🟠404

Request Example

Shell

JavaScript

Java

Swift

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

Response Example

200 - Success

{
    "message": "Bulk payout intent actions retrieved successfully",
    "status": "success",
    "data": {
        "id": "01J3KQZM0000000000000000BK",
        "entity_id": "01HQZR2BKPFQ8MXJVT3G7LWNA",
        "payout_intent_id": "01J3KQZM0000000000000000AB",
        "status": "processing",
        "items": [
            {
                "index": 0,
                "status": "queued",
                "data": {
                    "type": "payout",
                    "account_id": "01HQZR2BKPFQ8MXJVT3G7LWNE",
                    "currency": "NGN",
                    "amount": 500000,
                    "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"
                    }
                },
                "error": null
            },
            {
                "index": 1,
                "status": "invalid",
                "data": {
                    "type": "payout",
                    "account_id": "01HQZR2BKPFQ8MXJVT3G7LWNE",
                    "currency": "NGN",
                    "amount": -100,
                    "counterparty": {
                        "email": "not-an-email",
                        "account_number": "0123456789",
                        "bank_code": "044"
                    }
                },
                "error": "amount must be a positive integer"
            }
        ],
        "created": 1755008400000,
        "updated": 1755008400000
    }
}

Modified at 2026-09-13 22:34:55

Create bulk payout intent actions

Preview bulk payout intent actions