v1

latestOpenAPI 3.1.02026-07-26540161.7 KB

Verify Payout Status by Customer Reference

This API lets you retrieve and view a specific payout

get/disbursements/payouts/customer-reference/{customerReference}

Path parameters

customerReferencestring required

The transaction's unique identifier on your system

Response

200

successboolean
messagestring

Example response

{
  "success": true,
  "message": "Payout fetched successfully",
  "data": {
    "id": 31821,
    "amountSent": 4500.67,
    "amountReceived": 9.9,
    "sourceCurrency": "KES",
    "destinationCurrency": "EUR",
    "fee": 9090.909091,
    "quoteId": "6490a6937d6dab0011852bc4",
    "status": "successful",
    "reference": "db396365d80b4d6c",
    "description": "i want to sha pay money",
    "paymentDestination": "bank_account",
    "paymentScheme": "sepa_instant",
    "message": "Payout was successful",
    "valuedAt": "2023-06-19T19:03:57.000Z",
    "createdAt": "2023-06-19T19:03:48.000Z",
    "updatedAt": "2023-06-19T19:03:57.000Z",
    "recipient": {
      "firstName": "Hassan",
      "lastName": "Sarz",
      "accountHolderName": "Ehee",
      "email": "aa@aa.com",
      "phone": "0803443433",
      "accountNumber": "0690000040",
      "type": "individual",
      "country": "NG",
      "bankCode": "044",
      "sortCode": "058",
      "bankSwiftCode": "6666",
      "bankAddress": {
        "country": "ng",
        "state": "Los Angeles",
        "zip": "344",
        "city": "maid",
        "street": "23, 3"
      }
    }
  }
}