Fetch List By Batch Reference

These endpoints enable fetching a paginated list of single transfers (bank and inter-merchant transfers) contained in the batch.

Fetching List With Batch Reference

get

/v1/transfers/batch/{batch_reference}/transfers

Authorizations

Path parameters

batch_referencestringrequired

Query parameters

searchstring

Search parameter to use while filtering the list

pageinteger · int32

The target page to retrieve if available. Minimum value is 1.

page_sizeinteger · int32

Required page size. Acceptable range is from 1 to 100.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/v1/transfers/batch/{batch_reference}/transfers' \
  --header 'Authorization: YOUR_API_KEY'

200

200

{
  "status": "success",
  "message": "text",
  "meta": {
    "page_meta": {
      "page_count": 1,
      "item_count": 1,
      "search": "text",
      "page": 1,
      "page_size": 1
    }
  },
  "is_error": true,
  "data": [
    {
      "id": "text",
      "is_live": true,
      "account_name": "text",
      "account_number": "text",
      "bank_name": "text",
      "bank_code": "text",
      "destination_gateway_code": "text",
      "destination_gateway_merchant_id": "text",
      "destination_gateway_merchant_name": "text",
      "session_id": "text",
      "reference": "text",
      "batch_reference": "text",
      "beneficiary_id": "text",
      "country": "text",
      "currency": "text",
      "amount": 1,
      "transfer_fee": 1,
      "description": "text",
      "status": "successful",
      "failed_batch_validation": true,
      "failure_reason": "text",
      "transfer_type": "bank",
      "created_at": "2025-02-20T19:24:05.874Z",
      "edited_at": "2025-02-20T19:24:05.874Z",
      "paid_at": "2025-02-20T19:24:05.874Z",
      "wallet_account_tags": [
        {
          "account_tag": "text",
          "amount": 1,
          "description": "text",
          "metadata": "text"
        }
      ]
    }
  ],
  "errors": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  }
}

Success