payouts.transfer.completed
Generated from COPE public event contracts. Do not edit this page by hand.Use this event to reconcile completed transfer movement in vendor payout workflows.
Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
A payout transfer has completed.
Generated from COPE public event contracts. Do not edit this page by hand.Use this event to reconcile completed transfer movement in vendor payout workflows.
| Field | Value |
|---|---|
| Encoding | CloudEvents 1.0 structured JSON |
| Delivery | At least once |
| Idempotency | Use the CloudEvents source + id tuple, or COPE idempotency_key when available. |
| Source | cope.payouts |
| Subject pattern | transfer:<identifier> |
| Category | Payouts |
| Availability | Available in the public webhook reference. |
| Schema title | payouts.transfer.completed v1 payload |
| Schema ID | https://schemas.cope.com/events/payouts.transfer.completed/v1 |
| Field | Required | Type | Allowed Values | Description |
|---|---|---|---|---|
additional_recipients | no | array | - | Optional. Additional recipient email addresses configured in the vendor’s notification settings. Each recipient receives an individually addressed copy of the notification email. Capped at 5 recipients. |
amount_cents | yes | integer | - | - |
completed_at | yes | string | - | - |
currency | yes | string | - | - |
fee_cents | yes | integer | - | - |
net_cents | yes | integer | - | - |
processor_transfer_ref | yes | string | - | - |
{
"data": {
"amount_cents": 1000,
"completed_at": "2026-05-05T12:00:00.000Z",
"currency": "EUR",
"fee_cents": 1000,
"net_cents": 1000,
"processor_transfer_ref": "example_processor_transfer_ref"
},
"datacontenttype": "application/json",
"dataschema": "https://schemas.cope.com/events/payouts.transfer.completed/v1",
"id": "payouts.transfer.completed:example",
"idempotency_key": "payouts.transfer.completed:example",
"source": "cope.payouts",
"specversion": "1.0",
"subject": "transfer:example",
"time": "2026-05-05T12:00:00.000Z",
"type": "payouts.transfer.completed"
}
Was this page helpful?