Skip to main content

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.

Delivery Contract

FieldValue
EncodingCloudEvents 1.0 structured JSON
DeliveryAt least once
IdempotencyUse the CloudEvents source + id tuple, or COPE idempotency_key when available.
Sourcecope.payouts
Subject patterntransfer:<identifier>
CategoryPayouts
AvailabilityAvailable in the public webhook reference.
Schema titlepayouts.transfer.completed v1 payload
Schema IDhttps://schemas.cope.com/events/payouts.transfer.completed/v1

Payload Fields

FieldRequiredTypeAllowed ValuesDescription
amount_centsyesinteger--
completed_atyesstring--
currencyyesstring--
fee_centsyesinteger--
net_centsyesinteger--
processor_transfer_refyesstring--

Example CloudEvent

{
  "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"
}

Compatibility

Fields may be added within the same major version. Removing or changing the meaning of a documented field requires a new event version.