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
Authorizations
Path parameters
idstringRequired
Responses
200
Success
application/json
get
GET /v1/transfers/single/{id} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200

Success

{
  "status": "success",
  "message": "text",
  "data": {
    "id": "text",
    "is_live": true,
    "wallet_account_tags": [
      {
        "account_tag": "text",
        "amount": 1,
        "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": 1,
    "source_currency_debit_amount": 1,
    "source_currency_transfer_fee": 1,
    "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": 1,
    "transfer_fee": 1,
    "description": "text",
    "status": "successful",
    "failed_batch_validation": true,
    "failure_reason": "text",
    "transfer_type": "bank",
    "created_at": "2025-07-06T21:50:10.093Z",
    "edited_at": "2025-07-06T21:50:10.093Z",
    "paid_at": "2025-07-06T21:50:10.093Z"
  },
  "meta": {},
  "errors": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "is_error": true
}

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

get
Authorizations
Path parameters
referencestringRequired

The reference of the single transfer to be retrieved

Responses
200
Success
application/json
get
GET /v1/transfers/single/reference/{reference} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200

Success

{
  "status": "success",
  "message": "text",
  "data": {
    "id": "text",
    "is_live": true,
    "wallet_account_tags": [
      {
        "account_tag": "text",
        "amount": 1,
        "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": 1,
    "source_currency_debit_amount": 1,
    "source_currency_transfer_fee": 1,
    "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": 1,
    "transfer_fee": 1,
    "description": "text",
    "status": "successful",
    "failed_batch_validation": true,
    "failure_reason": "text",
    "transfer_type": "bank",
    "created_at": "2025-07-06T21:50:10.093Z",
    "edited_at": "2025-07-06T21:50:10.093Z",
    "paid_at": "2025-07-06T21:50:10.093Z"
  },
  "meta": {},
  "errors": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "is_error": true
}

Last updated