Payment request events
Payment request events use the v1.collection.payment_request.* prefix. The current lifecycle events are created, part_paid, paid and cancelled.
Overview
Payment Requests let you collect money via a pre-generated link. Whenever a request moves through its life-cycle we emit a webhook so your system can react in real-time (update UI, trigger fulfilment, etc.).
Event catalogue
| Event | When it triggers |
|---|---|
v1.collection.payment_request.created | The payment request is first generated |
v1.collection.payment_request.part_paid | A partial payment is captured but the payable balance > 0 |
v1.collection.payment_request.paid | The request balance reaches 0 from payments in RECEIVED or COMPLETE |
v1.collection.payment_request.cancelled | The request is cancelled by the user or after a payment is rejected |
Event flow
payment_request.paid is an aggregate balance signal: it means the requested balance is covered even while an individual payment remains RECEIVED. For crypto, use the individual payment.completed event and confirm its API status is COMPLETE. A later crypto compliance rejection can cancel a previously paid or part-paid request. See Payment lifecycle and webhooks.
