Payout Webhook

payout.successful

This event is dispatched whenever an authenticated user initiates transfer/payout and it is successful.

{
 "event": "payout.successful",
 "data": {
   "id": 14380,
   "amountCharged": 528947.3684210526,
   "amountReceived": 855,
   "recipient": {
     "name": "Hassan Sarz",
     "accountNumber": "0124775489",
     "type": "individual",
     "email": "[email protected]"
   },
   "fee": 150,
   "rate": 0.0019,
   "paymentScheme": "fps",
   "paymentDestination": "bank_account",
   "sourceCurrency": "NGN",
   "destinationCurrency": "GBP",
   "status": "successful",
   "createdAt": "2022-02-20T21:23:44.000Z",
   "updatedAt": "2022-02-20T21:23:50.000Z",
   "reference": "bf2eb02e-39fe-490a-b933-63f8c4d42125",
   "reason": "Payout was successful",
   "traceId": null,
   "valuedAt": "2022-02-20T21:23:50.000Z"
 }
}

payout.failed

This event is dispatched whenever an authenticated user initiates transfer/payout and it fails.

{
  "event": "payout.failed",
  "data": {
    "id": 14382,
    "amountCharged": 12150,
    "amountReceived": 12000,
    "recipient": {
      "name": "Hassan Sarz",
      "accountNumber": "0124775489",
      "type": "individual",
      "email": "[email protected]"
    },
    "fee": 150,
    "rate": 1,
    "paymentScheme": "fps",
    "paymentDestination": "bank_account",
    "sourceCurrency": "GBP",
    "destinationCurrency": "GBP",
    "status": "failed",
    "createdAt": "2022-02-21T03:51:53.000Z",
    "updatedAt": "2022-02-21T03:54:10.000Z",
    "reference": "9fd3f916-3b03-4bb2-af69-f42b64925919",
    "reason": "Wrong beneficiary bank details",
    "traceId": null,
    "valuedAt": null
  }
}

Webhook Parameters And Description

DataDescription
data.idThe unique payout ID generated for the payout
data.amountChargedThe addition of the transaction fee and amount to be sent to the recipient
data.amountReceivedThe amount the recipient receives
data.recipient.nameThe recipient name
data.recipient.accountNumberThe recipient account number
data.recipient.typeThe recipient type
data.recipient.emailThe recipient email
data.feeThe fee charged for the transaction
data.rateThe quoted rate
data.paymentSchemeThe payment scheme used in processing the payout
data.paymentDestinationThe account that received the payment
data.sourceCurrencyThe currency used in making the payout
data.destinationCurrencyThe currency that the recipient receives the payment *in
data.statusThe status of the payout
data.createdAtThe timestamp the payout was created
data.updatedAtThe timestamp the payout was updated
data.referenceThe unique reference generated for the payout
data.reasonThe reason for making the payout
data.traceIdThe traceId(sessionId) is a transaction identifier recognised across Nigerian banks
data.valuedAtThe timestamp on which the account holder receives the funds