Skip to content

docs / payouts

Payouts

A payout transfers funds from your merchant wallet to a beneficiary's bank account or mobile wallet. Funds are debited from your balance immediately and delivered within minutes to hours depending on the destination.

The payout object

json
{
  "id": "f7e3a291-...",
  "publicId": "pyt_01j9abc456",
  "status": "succeeded",
  "sourceCurrency": "NGN",
  "sourceAmount": "500000",
  "destinationCurrency": "NGN",
  "destinationAmount": "500000",
  "feeAmount": "7500",
  "merchantReference": "WITHDRAWAL-5678",
  "beneficiary": {
    "accountName": "Kwame Mensah",
    "accountNumber": "0123456789",
    "bankCode": "044",
    "bankName": "Access Bank",
    "country": "NG"
  },
  "providerReference": "FIN-9876543",
  "createdAt": "2025-01-15T10: 00: 00Z"
}

Statuses

StatusDescription
pendingAccepted and queued
processingSent to payment channel
succeededCredited to beneficiary
failedChannel rejected or timed out
reversedSucceeded but later reversed by the channel

Initiate a payout

POST/v1/payouts