Skip to main content

Events and payloads

EventWhen it fires
payment.successA transaction is confirmed successful
payment.failedA transaction is confirmed failed
payment.reversedA successful transaction is reversed
withdrawal.approvedAn administrator approves a withdrawal
withdrawal.completedA withdrawal payout is confirmed complete
withdrawal.rejectedAn administrator rejects a withdrawal

All payloads share an envelope:

{
"event": "payment.success",
"reference": "SKY-20241215-A7X9K2",
"timestamp": "2024-12-15T10:30:00.000Z",
"data": {
"reference": "SKY-20241215-A7X9K2",
"amount": 500000,
"currency": "NGN",
"status": "SUCCESS",
"gateway": "payaza",
"customerEmail": "[email protected]"
}
}

amount is integer kobo. Payloads may gain additional fields over time, so ignore unknown fields rather than rejecting the entire event.

Withdrawal payloads include withdrawalId, amountKobo, netAmountKobo, and status. A rejection also includes rejectionReason. Never interpret an approval as proof that a bank transfer completed; wait for withdrawal.completed or inspect the dashboard.