Payments

Audience: partners integrating with our push notification service.

Scope: events whose event value starts with v1.collection.payment_request.payment.* – namely created, pending, received, completed failed, and reversed.

Version: 1.0

---

1. Overview

Payment events trigger whenever a payment moves through its life‑cycle against a payment request, 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.payment.created	Reserved for future use. Intended to represent an initial state
v1.collection.payment_request.payment.pending	Authorised (for card payments), pending confirmation (for crypto), or reported as sent by the customer
v1.collection.payment_request.payment.received	Funds received on blockchain, card network, or bank
v1.collection.payment_request.payment.completed	Final payout made; funds credited to wallet
v1.collection.payment_request.payment.failed	Payment failed due to error or rejection
v1.collection.payment_request.payment.reversed	Reserved for future use. Intended to represent a post-completion reversal

3. Event flow

---

4. Additional data

Each payment.* event includes the following properties in the data object:

{
  "paymentRequestId": "8a282576-18c0-4c0e-b158-44b92eda1afe"
}

Additional fields may be present depending on the event type. See the callback documentation for full schema details.

---