Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
A payout to the bank was canceled.
Generated from COPE public event contracts. Do not edit this page by hand.Use this event to stop expecting a payout that was canceled before it left Stripe. The money stays in your Stripe balance.
| Field | Value |
|---|---|
| Encoding | JSON: id, type, version, source, created_at, occurred_at, data |
| Delivery | At least once |
| Idempotency | Deduplicate on id: every retry and replay of this event repeats it, and X-Cope-Event-Id carries it. |
| Source | cope.payouts |
| Category | Payouts |
| Availability | Available in the public webhook reference. |
| Schema title | payouts.external_payout.canceled webhook body |
| Schema ID | https://schemas.cope.com/webhooks/payouts.external_payout.canceled/v1 |
| Field | Required | Type | Allowed Values | Description |
|---|---|---|---|---|
amount_cents | yes | integer | - | What COPE sent to the seller’s Stripe balance for this payout, net of the payout fee, in currency. When Stripe converted the transfer the balance was credited in another currency: that amount is received, and what the bank receives is Stripe’s payout of the balance. |
business | no | object | - | The business this event concerns. Carries object (what it is) and id (which one); id is the public identifier a merchant addresses it by. |
canceled_at | yes | string | - | - |
currency | yes | string | - | - |
payout | no | object | - | The payout this event concerns. Carries object (what it is) and id (which one); id is the public identifier a merchant addresses it by. |
received | no | object | - | What the transfer credited to the seller’s Stripe balance (their payout account at Stripe), read from the transfer’s destination payment after the payout was booked. It is not what the bank received: Stripe may convert again when it pays the balance out. Omitted until COPE has read it, and for payouts made before COPE recorded it. COPE’s own books stay in the payout’s currency. |
{
"created_at": "2026-05-05T12:00:00.000Z",
"data": {
"amount_cents": 4900,
"business": {
"id": "biz_g7-Jq2PxT_4mRvNa",
"object": "business"
},
"canceled_at": "2026-05-12T16:30:12Z",
"currency": "EUR",
"payout": {
"id": "po_R2mX8sKq4TbW",
"object": "payout"
},
"received": {
"amount_minor_units": 4547,
"currency": "CHF",
"exchange_rate": "0.927958"
}
},
"id": "8d2f6c1a-4e7b-4a39-b5d0-2c9e1f7a3b64",
"occurred_at": "2026-05-05T11:59:58.500Z",
"source": "cope.payouts",
"type": "payouts.external_payout.canceled",
"version": "v1"
}
Was this page helpful?