Skip to main content
GET
/
v1
/
batches
/
{id}
/
payouts
List payouts in a batch
curl --request GET \
  --url http://localhost:8080/v1/batches/{id}/payouts \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "pay_cq1234567890abcdef",
      "merchant_id": "<string>",
      "beneficiary_id": "<string>",
      "batch_id": "<string>",
      "idempotency_key": "<string>",
      "status": "created",
      "method": "bank_transfer",
      "source_amount": "<string>",
      "source_currency": "<string>",
      "dest_amount": "<string>",
      "dest_currency": "<string>",
      "exchange_rate": "<string>",
      "fee": "<string>",
      "fee_currency": "<string>",
      "rail_type": "fiat",
      "rail_provider": "<string>",
      "rail_reference": "<string>",
      "network": "<string>",
      "wallet_address": "<string>",
      "token_contract": "<string>",
      "token_symbol": "<string>",
      "tx_hash": "<string>",
      "block_confirmations": 123,
      "required_confirms": 123,
      "network_fee": "<string>",
      "network_fee_currency": "<string>",
      "purpose": "<string>",
      "reference": "<string>",
      "compliance_status": "<string>",
      "metadata": {},
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "screened_at": "2023-11-07T05:31:56Z",
      "approved_at": "2023-11-07T05:31:56Z",
      "processed_at": "2023-11-07T05:31:56Z",
      "completed_at": "2023-11-07T05:31:56Z",
      "failed_at": "2023-11-07T05:31:56Z",
      "cancelled_at": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "limit": 123,
    "offset": 123,
    "total": 123,
    "has_more": true
  }
}

Authorizations

Authorization
string
header
required

Merchant API key: ak_live_... or ak_test_...

Path Parameters

id
string
required

Resource identifier (xid format)

Query Parameters

limit
integer
default:20

Maximum number of items to return

Required range: 1 <= x <= 100
offset
integer
default:0

Number of items to skip

Required range: x >= 0

Response

200 - application/json

Payouts belonging to the batch

data
object[]
pagination
object