Querying For Payouts

Payouts created outside merchant dashboard allows adding order reference.

This endpoint allows querying payouts using a your unique order references.

GET /third-parties/payouts/[YOUR_UNIQUE_ORDER_REFERENCE]

Headers

Name	Value
Content-Type	application/json
Authorization	Bearer <token>

Response

200

[
     {
          updatedAt: "2024-09-02T10:15:30.000Z",
          createdAt: "2024-09-01T14:22:10.000Z",
          id: "PAY17072CD",
          orderReference: "order_123456",
          amount: "20000.00",
          currency: "TZS",
          fee: "2360.00",
          status: "SUCCESS",
          channel: "BANK TRANSFER", // or MOBILE MONEY
          channelProvider: "Equity Bank Tanzania Limited",
          settlementType: "ACH", // or RTGS // if available
          notes: "Payment for invoice no. 123456", // if available
          beneficiary: {
              accountNumber: "123456789",
              accountName: "John Doe",
              swiftNumber: "ABC1234XYZ", // if available
              routingNumber: "110000000", // if available
              beneficiaryMobileNumber: "255600000000", // if available
              beneficiaryEmail: "[e-mail]" // if available
          }
     }
]

404

{
  "message": "Invalid or missing payouts:  [YOUR_UNIQUE_ORDER_REFERENCE]"
}

There are different payout status such as SUCCESS, PROCESSING, PENDING, FAILED, REFUNDED and REVERSED. Payouts with SUCCESS status are the one that were initiated successfully, REFUNDED, funds were returned to the merchant account before being transferred to the beneficiary account. REVERSED payouts are those which the transfer process was initiated (i.e. Payout with SUCCESS status) but were returned to merchant due to issues such us incorrect account name (most happens with BANK TRANSFER when merchant added wrong name for beneficiary account).