data holds the transaction.
The forms an event takes
The same event reaches you in one of three forms, depending on how you look at it and how it was sent.- The HTTP request
- Automatic event
- Resent event
What arrives at your endpoint: a signed Verify
POST with a JSON body.X-Payve-Signature against the raw body before you parse it. See Verify signatures.Read this first
data carries more fields than these samples show. Rely only on the fields documented on this
page. Others can change or disappear without notice.Numeric ids and amounts in
data arrive as strings of digits, such as "1842" and "5000000".
Parse amounts as integers. Use data.id as the {id} in API URLs.Fields in data
How the money moved:
bank_transfer, mobile_money, virtual_account or card. null on a
conversion.The amount in
destination_currency, in minor units. On a pay-in, the net amount credited to your
wallet.Payloads by event
Pick the event to see its full payload and what to do when it arrives.Payouts
- payout.successful
- payout.failed
The payout arrived.Do: mark your payment as sent. Your wallet was debited
source_amount plus fee_amount.Pay-ins
- payin.successful
- payin.failed
- payin.expired
A pay-in was received.Do: fetch the pay-in and fulfil the order if it is
successful and not underpaid. In this sample the payer sent ₦50,000.00 (source_amount), and ₦49,700.00 (destination_amount) was credited after a ₦250.00 fee and ₦50.00 tax.Conversions
- conversion.successful
- conversion.failed
A conversion completed. The destination wallet was credited.Do: record the conversion.
source_amount left the source wallet and destination_amount reached the destination wallet.Resent events
When you call aresend-webhook endpoint, Payve sends a fresh event. It differs from the automatic one in three ways.
- Payout
- Pay-in
- Conversion

