Payouts

Audience: partners integrating with our push notification service.

Scope: events whose event value starts with v1.collection.payment_request.payment.payout.* – namely * *pending_approval**, initiated, paid, and failed.

Version: 1.0

---

1. Overview

Payout events trigger whenever a payout moves through its life‑cycle against a payment request payment, we emit a webhook so your system can react in real‑time (update UI, track fund transfers, etc.).

---

2. Event catalogue

Event	When it triggers
v1.collection.payment_request.payment.payout.pending_approval	Payment is awaiting checker approval (only when maker checker is enabled on the account)
v1.collection.payment_request.payment.payout.initiated	Payment has been initiated
v1.collection.payment_request.payment.payout.paid	Payment has been successfully completed and funds have been paid
v1.collection.payment_request.payment.payout.failed	Payment failed due to error or rejection

3. Event flow

---

4. Additional data

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

{
  "paymentRequestId": "8a282576-18c0-4c0e-b158-44b92eda1afe",
  "paymentId": "9b393687-29d1-5d1f-c269-55c03fda2bfb",
  "transactionReference": "TX123456789"
}

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

---