Fetch List By Batch Reference

These endpoints enable fetching a paginated list of single transfers (bank and inter-merchant transfers) contained in the batch.

Fetching List With Batch Reference

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

Path parameters

batch_reference*string

Query parameters

Response

200

Success

Body

application/json

statusApiStatusResponse (enum)

successerror

messagenullable string

datanullable array of ViewSwAppTransferDto (object)

metaPagedMeta (object)

errorsnullable object

is_errorboolean

Request

JavaScriptCurlPython

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

Response

200

{
  "status": "success",
  "message": "text",
  "data": [
    {
      "id": "text",
      "is_live": false,
      "wallet_account_tags": [
        {
          "account_tag": "text",
          "amount": 0,
          "description": "text",
          "metadata": "text"
        }
      ],
      "account_name": "text",
      "account_number": "text",
      "bank_name": "text",
      "bank_code": "text",
      "destination_gateway_code": "text",
      "destination_gateway_merchant_id": "text",
      "destination_gateway_merchant_name": "text",
      "session_id": "text",
      "reference": "text",
      "batch_reference": "text",
      "beneficiary_id": "text",
      "country": "text",
      "currency": "text",
      "amount": 0,
      "transfer_fee": 0,
      "description": "text",
      "status": "successful",
      "failed_batch_validation": false,
      "failure_reason": "text",
      "transfer_type": "bank",
      "created_at": "2024-11-15T16:41:32.207Z",
      "edited_at": "2024-11-15T16:41:32.207Z",
      "paid_at": "2024-11-15T16:41:32.207Z"
    }
  ],
  "meta": {
    "page_meta": {
      "search": "text"
    }
  },
  "is_error": false
}