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 has failed.
Generated from COPE public event contracts. Do not edit this page by hand.Use this event to act on a payout your bank refused or returned, for example because the account was closed.
failure_code and failure_message are Stripe’s. The money is back in your Stripe balance and is sent again with a later payout once the bank details are fixed.
| Field | Value |
|---|---|
| Encoding | JSON: id, type, version, source, created_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.failed webhook body |
| Schema ID | https://schemas.cope.com/webhooks/payouts.external_payout.failed/v1 |
| Field | Required | Type | Allowed Values | Description | |
|---|---|---|---|---|---|
amount_cents | yes | integer | - | What this payout sent to the connected account and on to the bank: the net of the payout fee. | |
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. | |
currency | yes | string | - | - | |
failed_at | yes | string | - | - | |
failure_code | no | `string | null` | - | Stripe’s payout failure code, for example account_closed. |
failure_message | no | `string | null` | - | Stripe’s explanation of the failure, suitable to show the seller. |
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. |
{
"created_at": "2026-05-05T12:00:00.000Z",
"data": {
"amount_cents": 4900,
"business": {
"id": "biz_g7-Jq2PxT_4mRvNa",
"object": "business"
},
"currency": "EUR",
"failed_at": "2026-05-12T16:30:12Z",
"failure_code": "example_failure_code",
"failure_message": "example_failure_message",
"payout": {
"id": "po_R2mX8sKq4TbW",
"object": "payout"
}
},
"id": "8d2f6c1a-4e7b-4a39-b5d0-2c9e1f7a3b64",
"source": "cope.payouts",
"type": "payouts.external_payout.failed",
"version": "v1"
}