Event catalogue
Every state change emits an event. Subscribe to the ones you need per endpoint, using wildcards such as credit.*.
| Event | When |
|---|---|
| collection_account.created / .frozen / .closed | Account lifecycle |
| credit.received | Funds arrived, decision pending |
| credit.settled | Accepted; funds available |
| credit.in_review | Held for analyst |
| credit.returned | Sent back to source (reason included) |
| checkout_session.paid / .underpaid / .expired / .refunded | Checkout lifecycle |
| hold.released / hold.reversed | Marketplace escrow |
| payout.paid / payout.failed | Outbound |
| sweep.completed · conversion.completed · blinc_transfer.completed | Treasury |
| recall.opened / recall.updated / recall.closed | Recalls |
Envelope
Every event has an id, a type, a created_at timestamp and a data object containing the resource as it was when the event was created.
{
"id": "ev_5Tq81",
"type": "credit.settled",
"created_at": "2026-11-05T14:02:13Z",
"data": {
"id": "cr_2Kd9xZ",
"collection_account": "ca_9Hc2LmQ",
"external_ref": "mch_8F2K91",
"amount": 1240000,
"currency": "EUR",
"rail": "sepa",
"payer": {
"name": "Kestrel Logistics GmbH",
"iban": "DE89 •••• •••• •••• 3000 00",
"country": "DE"
},
"shield": {
"name_match": "exact",
"score": 1.0,
"screening": "clear",
"decision": "accept"
},
"remittance_info": "INV-2291",
"settled_at": "2026-11-05T14:02:13Z"
}
}Return reasons
credit.returned includes a return_reason of third_party_funds, account_closed, account_frozen, screening_hit, limit_exceeded, country_blocked, session_expired or review_timeout.
{
"id": "ev_5Tq94",
"type": "credit.returned",
"created_at": "2026-11-05T15:41:07Z",
"data": {
"id": "cr_7Pq1nW",
"collection_account": "ca_4Rt8KpL",
"external_ref": "mch_2A7D55",
"amount": 480000,
"currency": "EUR",
"rail": "sepa",
"payer": { "name": "J. Marsh", "iban": "FR14 •••• •••• •••• 0606 10", "country": "FR" },
"shield": {
"name_match": "no_match",
"score": 0.08,
"screening": "clear",
"decision": "return"
},
"return_reason": "third_party_funds",
"returned_at": "2026-11-05T15:41:07Z"
}
}