Remittance Action Required

A remittance is awaiting action: supplementary information or reconfirmation after a price change.

Event Types

Event	When Emitted
`remittance.order.action_required`	Member action required: confirm a new price or provide supplementary documents

Delivery Contract

We send a POST request with application/json to your configured endpoint, with a 10-second timeout.
Any 2xx response acknowledges receipt. Non-2xx responses and timeouts trigger retries with backoff.
Four request headers: content-type · z-signature · z-event-id · z-event-type。
Deduplicate by z-event-id — the same event may be delivered more than once.

Event payloads contain only IDs and status

There are no amounts, asset codes, card number fragments or risk-control reasons. This is a security boundary: the webhook endpoint is your service, whose transport and storage we cannot guarantee. The GET /v1/<resource>/{id} endpoint applies API key, scope and on-behalf-of checks. Fetch details using data.id; do not use webhook payloads as the source of amounts for your ledger.

Event Details

remittance.order.action_required Member action required: confirm a new price or provide supplementary documents

When Emitted

Two situations share this event: exchange-rate movement beyond the member’s chosen limit requires reconfirmation, or the upstream requests supplementary documents. Both have deadlines: missing the reconfirmation deadline automatically cancels the order and returns locked funds; if documents are not supplied, the order remains stalled and the funds stay locked. Direct the member to the order immediately and retrieve GET /v1/remittances/rmt_<id>/pending-action to determine what they must do. The event body does not distinguish these two situations.

Payload

{
  "event_id": "evt_74b0d3e18f6a4c29ba51e07d962f4c83",
  "event_type": "remittance.order.action_required",
  "created_at": "2026-08-12T14:12:19Z",
  "merchant_id": "acme",
  "livemode": true,
  "data": {
    "object": "remittance",
    "id": "1c0e8a37-45bd-4f6a-b2e1-90a7d3f5c862",
    "external_member_id": "u_88123",
    "status": "action_required",
    "status_version": 3
  }
}

Signature Verification

The signature verification procedure is the same for all events. See Webhook Overview; use the Signature Debugger to compare signing strings character by character.