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

Fetching By Batch Reference

PreviousList Batch Transfers NextRequeue All Failed Transfers

Last updated 3 months ago

get

/v1/transfers/batch/{id}

Authorizations

Path parameters

idstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

{
  "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-02-20T19:22:58.918Z",
    "otp_validated": true,
    "otp_validated_at": "2025-02-20T19:22:58.918Z",
    "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-02-20T19:22:58.918Z",
    "edited_at": "2025-02-20T19:22:58.918Z"
  },
  "meta": {},
  "is_error": true,
  "errors": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  }
}

Success

get

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