Fetch A Single Disbursement

These endpoints enable fetching a single disbursement using its ID or the supplied reference.

Single disbursements

Fetch Single Disbursement By ID

GET/v1/transfers/single/{id}

Path parameters

id*string

Response

200

Success

Body

application/json

statusApiStatusResponse (enum)

successerror

messagenullable string

dataViewSwAppTransferDto (object)

NOTE: This Dto contains the combined properties of both bank and inter-merchant disbursements The type of the transfer should be retrieved before accessing the properties expected of that type.

metaNoMeta (object)

errorsnullable object

is_errorboolean

Request

JavaScriptCurlPython

const response = await fetch('/v1/transfers/single/{id}', {
    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_merchant_id": "text",
    "destination_gateway_merchant_name": "text",
    "destination_gateway_name": "text",
    "destination_gateway_code": "text",
    "rate": 0,
    "source_currency_debit_amount": 0,
    "source_currency_transfer_fee": 0,
    "sort_code": "text",
    "swift_code": "text",
    "email": "text",
    "phone_number": "text",
    "street_number": "text",
    "street_name": "text",
    "city": "text",
    "postal_code": "text",
    "session_id": "text",
    "reference": "text",
    "batch_reference": "text",
    "batch_title": "text",
    "beneficiary_id": "text",
    "country": "text",
    "currency": "text",
    "source_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-16T16:46:17.784Z",
    "edited_at": "2024-11-16T16:46:17.784Z",
    "paid_at": "2024-11-16T16:46:17.784Z"
  },
  "is_error": false
}

Retrieves a single transfer using its reference. A single transfer contains a property linking it to its batch entry.

GET/v1/transfers/single/reference/{reference}

Path parameters

reference*string

The reference of the single transfer to be retrieved

Response

200

Success

Body

application/json

statusApiStatusResponse (enum)

successerror

messagenullable string

dataViewSwAppTransferDto (object)

NOTE: This Dto contains the combined properties of both bank and inter-merchant disbursements The type of the transfer should be retrieved before accessing the properties expected of that type.

metaNoMeta (object)

errorsnullable object

is_errorboolean

Request

JavaScriptCurlPython

const response = await fetch('/v1/transfers/single/reference/{reference}', {
    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_merchant_id": "text",
    "destination_gateway_merchant_name": "text",
    "destination_gateway_name": "text",
    "destination_gateway_code": "text",
    "rate": 0,
    "source_currency_debit_amount": 0,
    "source_currency_transfer_fee": 0,
    "sort_code": "text",
    "swift_code": "text",
    "email": "text",
    "phone_number": "text",
    "street_number": "text",
    "street_name": "text",
    "city": "text",
    "postal_code": "text",
    "session_id": "text",
    "reference": "text",
    "batch_reference": "text",
    "batch_title": "text",
    "beneficiary_id": "text",
    "country": "text",
    "currency": "text",
    "source_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-16T16:46:17.784Z",
    "edited_at": "2024-11-16T16:46:17.784Z",
    "paid_at": "2024-11-16T16:46:17.784Z"
  },
  "is_error": false
}