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

Query parameters

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.

metaPagedMeta (object)

errorsnullable object

is_errorboolean

Request

JavaScriptCurlPython

const response = await fetch('/v1/transfers/batch', {
    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:33:23.762Z",
    "otp_validated": false,
    "otp_validated_at": "2024-11-16T16:33:23.762Z",
    "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:33:23.762Z",
    "edited_at": "2024-11-16T16:33:23.762Z"
  },
  "meta": {
    "page_meta": {
      "search": "text"
    }
  },
  "is_error": false
}