Payment request

Audience: partners integrating with our push notification service.

Scope: events whose event value starts with v1.collection.payment_request.* – namely created, paid, part_paid and cancelled.

Version: 1.0

---

1. 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.).

---

2. 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
v1.collection.payment_request.cancelled	The request is unpaid and is cancelled

3. Event flow

---