List Batch Transfers

Retrieve the list of all batch transfers. A batch transfer contains the totals of all the transfers in the batch transfer list.

get

Authorizations

Bearer

AuthorizationstringRequired

API Key as Bearer Token

Query parameters

searchstringOptional

Search parameter to use while filtering the list

pageinteger · int32Optional

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

page_sizeinteger · int32Optional

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

Responses

200

Success

application/json

get

/v1/transfers/batch

HTTPcURLJavaScriptPython

GET /v1/transfers/batch HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200

Success

{
  "status": "success",
  "message": "text",
  "data": {
    "id": "text",
    "is_live": true,
    "batch_reference": "text",
    "source_currency": "text",
    "break_on_validation_failure": true,
    "two_factor_enabled": true,
    "otp_sent": true,
    "otp_expires_at": "2025-12-15T19:59:31.691Z",
    "otp_validated": true,
    "otp_validated_at": "2025-12-15T19:59:31.691Z",
    "total_count": 1,
    "failed_count": 1,
    "successful_count": 1,
    "total_amount": 1,
    "total_successful_amount": 1,
    "total_fee": 1,
    "batch_webhook_type": "batchOnly",
    "batch_notification_interval": "tenPercent",
    "title": "text",
    "description": "text",
    "status": "allSuccessful",
    "created_at": "2025-12-15T19:59:31.691Z",
    "edited_at": "2025-12-15T19:59:31.691Z"
  },
  "meta": {
    "page_meta": {
      "page_count": 1,
      "item_count": 1,
      "search": "text",
      "page": 1,
      "page_size": 1
    }
  },
  "errors": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "is_error": true
}