SwitchApp API
  • Introduction
  • Quick Start
  • Authentication
  • Errors
  • Metadata
  • Pagination
  • Versioning
  • No-code solutions
  • Webhooks
  • Payments
    • Transactions
      • Initialize a transaction
      • Verify transaction
      • List transactions
      • Retrieve Transaction
      • Transaction Webhooks
  • Payment Providers
    • Payment Providers
  • Countries & Currencies
    • Countries
    • Currencies
  • Products
    • Products
      • Create a product
      • Retrieve a product
      • Update a product
      • List all products
      • Delete a product
  • Customers
    • Customers
      • Create Customer
      • List Customers
      • Fetch Customer
      • Update Customer
      • Delete/Archive Customer
  • Payment Links
    • Payment Links
      • Create a payment link
      • Fetch payment link
      • Update a payment link
      • List all payment links
      • Delete a payment link
  • Payouts
    • Payouts
      • List Payouts
      • Fetch Payout
      • Retry Payout
  • BALANCES
    • Balances
      • Fetch all balances
      • Fetch a balance
      • Fetch currency balance
  • DISBURSEMENTS
    • Disbursements (Transfers)
      • Batch Disbursements
        • Initiate A Disbursement
        • List Batch Transfers
        • Fetch A Batch
        • Requeue All Failed Transfers
      • Single Disbursements
        • Fetch List By Batch Reference
        • Fetch All Singles By Page
        • Fetch A Single Disbursement
        • Fetch fee
        • Fetch rate
    • Beneficiaries
      • Create a beneficiary
      • List all beneficiaries
      • Fetch a beneficiary
      • Delete a beneficiary
    • Banks
      • Bank list
      • Bank slugs
      • Resolve account details
  • VIRTUAL ACCOUNTS
    • Virtual Accounts
      • Top-up virtual accounts
        • Fetch providers
        • Create top-up account
        • List accounts
        • Fetch account
        • Requery account
        • Deallocate account
      • Payment virtual accounts
        • Fetch providers
        • Create payment account
        • Update account details
        • List accounts
        • Fetch account
        • Requery account
        • Deallocate account
Powered by GitBook
On this page
  1. DISBURSEMENTS
  2. Disbursements (Transfers)
  3. Single Disbursements

Fetch A Single Disbursement

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

PreviousFetch All Singles By PageNextFetch fee

Last updated 6 months ago

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-05-20T14:55:50.564Z",
    "edited_at": "2025-05-20T14:55:50.564Z",
    "paid_at": "2025-05-20T14:55:50.564Z"
  },
  "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-05-20T14:55:50.564Z",
    "edited_at": "2025-05-20T14:55:50.564Z",
    "paid_at": "2025-05-20T14:55:50.564Z"
  },
  "meta": {},
  "errors": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "is_error": true
}
  • Fetch Single Disbursement By ID
  • GET/v1/transfers/single/{id}
  • GETRetrieves a single transfer using its reference. A single transfer contains a property linking it to its batch entry.