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/v1/transfers/batch/{id}

Path parameters

id*string

Response

200

Success

Body

application/json

statusApiStatusResponse (enum)

successerror

messagenullable string

dataViewBatchTransferDto (object)

This object contains the combined details for all transfer types: bank & gateway The total count includes the count for both bank disbursements and inter-merchant disbursements.

metaNoMeta (object)

errorsnullable object

is_errorboolean

Request

JavaScriptCurlPython

const response = await fetch('/v1/transfers/batch/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "status": "success",
  "message": "text",
  "data": {
    "id": "text",
    "is_live": false,
    "batch_reference": "text",
    "source_currency": "text",
    "break_on_validation_failure": false,
    "two_factor_enabled": false,
    "otp_sent": false,
    "otp_expires_at": "2024-11-16T16:40:00.347Z",
    "otp_validated": false,
    "otp_validated_at": "2024-11-16T16:40:00.347Z",
    "total_amount": 0,
    "total_successful_amount": 0,
    "total_fee": 0,
    "batch_webhook_type": "batchOnly",
    "batch_notification_interval": "tenPercent",
    "title": "text",
    "description": "text",
    "status": "allSuccessful",
    "created_at": "2024-11-16T16:40:00.347Z",
    "edited_at": "2024-11-16T16:40:00.347Z"
  },
  "is_error": false
}

Fetching By Batch Reference

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

Path parameters

batch_reference*string

Response

200

Success

Body

application/json

statusApiStatusResponse (enum)

successerror

messagenullable string

dataViewBatchTransferDto (object)

This object contains the combined details for all transfer types: bank & gateway The total count includes the count for both bank disbursements and inter-merchant disbursements.

metaNoMeta (object)

errorsnullable object

is_errorboolean

Request

JavaScriptCurlPython

const response = await fetch('/v1/transfers/batch/reference/{batch_reference}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "status": "success",
  "message": "text",
  "data": {
    "id": "text",
    "is_live": false,
    "batch_reference": "text",
    "source_currency": "text",
    "break_on_validation_failure": false,
    "two_factor_enabled": false,
    "otp_sent": false,
    "otp_expires_at": "2024-11-16T16:40:00.347Z",
    "otp_validated": false,
    "otp_validated_at": "2024-11-16T16:40:00.347Z",
    "total_amount": 0,
    "total_successful_amount": 0,
    "total_fee": 0,
    "batch_webhook_type": "batchOnly",
    "batch_notification_interval": "tenPercent",
    "title": "text",
    "description": "text",
    "status": "allSuccessful",
    "created_at": "2024-11-16T16:40:00.347Z",
    "edited_at": "2024-11-16T16:40:00.347Z"
  },
  "is_error": false
}