Events and payloads
| Event | When it fires |
|---|---|
payment.success | A transaction is confirmed successful |
payment.failed | A transaction is confirmed failed |
payment.reversed | A successful transaction is reversed |
withdrawal.approved | An administrator approves a withdrawal |
withdrawal.completed | A withdrawal payout is confirmed complete |
withdrawal.rejected | An 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",
}
}
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.