Fetch A Batch

Fetch the details of a batch disbursement by the ID of the batch or using your supplied reference.

These endpoints do not return the list of disbursements contained in the batch. To fetch the list of the transfers, use the single transfers endpoints.

Fetching By Batch Id

get

Authorizations

Bearer

AuthorizationstringRequired

API Key as Bearer Token

Path parameters

idstringRequired

Responses

200

Success

application/json

statusstring · enumOptionalPossible values:

messagestring · nullableOptional

metaobjectOptional

is_errorbooleanRead-onlyOptional

get

/v1/transfers/batch/{id}

HTTPcURLJavaScriptPython

GET /v1/transfers/batch/{id} HTTP/1.1
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": "2026-02-20T00:00:27.941Z",
    "otp_validated": true,
    "otp_validated_at": "2026-02-20T00:00:27.941Z",
    "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": "2026-02-20T00:00:27.941Z",
    "edited_at": "2026-02-20T00:00:27.941Z"
  },
  "meta": {},
  "errors": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "is_error": true
}

Fetching By Batch Reference

get

Authorizations

Bearer

AuthorizationstringRequired

API Key as Bearer Token

Path parameters

batch_referencestringRequired

Responses

200

Success

application/json

statusstring · enumOptionalPossible values:

messagestring · nullableOptional

metaobjectOptional

is_errorbooleanRead-onlyOptional

get

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

HTTPcURLJavaScriptPython

GET /v1/transfers/batch/reference/{batch_reference} HTTP/1.1
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": "2026-02-20T00:00:27.941Z",
    "otp_validated": true,
    "otp_validated_at": "2026-02-20T00:00:27.941Z",
    "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": "2026-02-20T00:00:27.941Z",
    "edited_at": "2026-02-20T00:00:27.941Z"
  },
  "meta": {},
  "errors": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "is_error": true
}