Skip to main content
Every payment — wallet funding, withdrawal, transfer or card charge — sends payment_intent.* events.

Events

Example

Data Fields

Fields that don’t apply to a payment are null or omitted.
string
The payment id. Some rejection and cancellation events send it as payment_id.
string
The transaction that moved the money, once there is one.
string
The user the payment belongs to.
string
The wallet debited. wallet_id is also sent when it differs from source_wallet_id.
string
The wallet credited.
string
The paying user.
string
The receiving user.
number
The amount in major units, e.g. 100.0 for $100.
string
ISO 4217 currency code.
integer | string
The payment status. When numeric, status_code and status_name are added (see below). Approval and review events send a string, e.g. approved.
string
Why the payment failed, was rejected or was cancelled.
string
For payments created through the unified payment API: the quote reference, with source_type, destination_type and destinations.

Status Codes

When status is numeric, the envelope’s type is payment_intent.<status_name>. For example, payment_intent.created arrives with type set to payment_intent.pending. Route on event_type.