İçeriğe geç
Apex Settlement
Webhooks

payout.updated

API referansındaki uç nokta açıklamaları İngilizcedir.

Sent once per change of a Payout the Customer (or, for a Platform, one of its End Customers) created: approval, funding, every step towards delivery, completion, failure, refund or cancellation. data is the Payout with its timeline, exactly as GET /v1/payouts/{id} answers it, except initiated_by_you, which needs a caller.

Each delivery is a POST of the event as JSON to every active endpoint subscribed to its type, signed in Apex-Signature. Answer any 2xx within ten seconds to acknowledge it; anything else, a redirect included, is a failure, retried after 30 seconds and then twice as long each time (at most four hours apart) for fifteen attempts, about a day in all. An endpoint that has failed for 24 hours is disabled. The same event may arrive more than once: deduplicate on its id (also in Apex-Event-Id). Events about a Platform's End Customer go to the Platform's endpoints and carry end_customer_id.

Başlık parametreleri

Apex-Signature*string

t=<unix seconds>,v1=<hex HMAC-SHA256>: the HMAC, keyed with the endpoint's whole whsec_… signing secret, of the timestamp, a full stop and the raw request body (<t>.<body>). Recompute it over the exact bytes received, compare in constant time, and refuse a timestamp far from your clock to stop replays. It is minted afresh on every attempt.

Apex-Event-Id*string

The event's id; the same on every attempt and every redelivery.

Biçimuuid
Apex-Event-Type*string

The event's type.

Apex-Delivery-Attempt*string

Which attempt this is, from 1.

İstek gövdesi

application/json
  1. body

The payout.updated event as it is delivered.

created_at*string

created_at is when the change happened, in UTC.

Biçimdate-time
data*

The resource as it stands after the change.

end_customer_id?string

end_customer_id says which of a Platform's End Customers the event is about.

id*string

id is the event's id, the same on every attempt and redelivery: a receiver deduplicates on it.

type*string

The event type.

Yanıt gövdesi

Acknowledged. Any 2xx counts; the body is kept, up to 2 KB, for the delivery log and otherwise ignored.

Örnek istekler
POST/payout.updated

The payout.updated event as it is delivered.

İstek gövdesi
application/json
{  "created_at": "2026-11-12T09:31:05Z",  "data": {    "beneficiary": {      "country": "DE",      "id": "7a1e4c2b-9d3f-4e8a-b6c5-1f2e3d4c5b6a",      "name": "Berlin Supplies GmbH",      "party_type": "business"    },    "cancellable": false,    "created_at": "2026-11-12T09:30:02Z",    "delivered_to": "bank_account",    "fees": [      {        "amount": {          "amount": "1",          "asset": "USDC"        },        "component": "provider",        "provider": "bvnk"      },      {        "amount": {          "amount": "0.5",          "asset": "EUR"        },        "component": "provider",        "provider": "bvnk"      }    ],    "id": "5f8d0c3e-2b7a-4d1e-9c6f-8a3b2e1d0c9f",    "initiated_by": {      "actor": "customer",      "id": "6e5d4c3b-2a1f-4e0d-8c9b-7a6f5e4d3c2b",      "kind": "api_key"    },    "legs": [      {        "from": "USDC",        "index": 0,        "provider": "bvnk",        "settled_at": "2026-11-12T09:30:41Z",        "state": "completed",        "to": "EUR"      },      {        "from": "EUR",        "index": 1,        "provider": "bvnk",        "settled_at": "2026-11-12T09:31:05Z",        "state": "completed",        "to": "EUR"      }    ],    "rates": [      {        "provider": "bvnk",        "rate": "0.92"      }    ],    "receive": {      "amount": "918.58",      "asset": "EUR"    },    "send": {      "amount": "1000",      "asset": "USDC"    },    "state": "completed",    "timeline": [      {        "at": "2026-11-12T09:30:02Z",        "by": {          "actor": "customer",          "id": "6e5d4c3b-2a1f-4e0d-8c9b-7a6f5e4d3c2b",          "kind": "api_key"        },        "state": "accepted"      },      {        "at": "2026-11-12T09:30:02Z",        "by": {          "actor": "system"        },        "state": "funded"      },      {        "at": "2026-11-12T09:30:03Z",        "by": {          "actor": "system"        },        "state": "processing"      },      {        "at": "2026-11-12T09:31:05Z",        "by": {          "actor": "system"        },        "state": "completed"      }    ],    "updated_at": "2026-11-12T09:31:05Z"  },  "id": "9b2f7c1e-5d4a-5e8b-a3c6-0f1d2e3a4b5c",  "type": "payout.updated"}
Başlık parametreleri
{  "Apex-Signature": "string",  "Apex-Event-Id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "Apex-Event-Type": "string",  "Apex-Delivery-Attempt": "string"}