v8

OpenAPI 3.1.02026-08-033623795.0 MB

Withdrawals

Withdrawal Created

Sent when a withdrawal is created

Required permissions:

payout:withdrawal:read
payout:destination:read
webhook_receive:withdrawals

postWebhookwithdrawal.created

Headers

webhook-idstring required

A unique identifier for this webhook request

Example:msg_xxxxxxxxxxxxxxxxxxxxxxxx

webhook-signaturestring required

The signature of the webhook request with the webhook version prepended

Example:v1,BASE64ENCODEDSIGNATURE

webhook-timestampstring required

The timestamp in seconds since the Unix epoch that the webhook was sent at on the server

Example:1727606400

Payload

api_version'v1' required

The API version for this webhook

api_version_datestring nullable required

The dated API version (Api-Version-Date) the payload is serialized to

company_idstring nullable

The account ID that this webhook event is associated with

idstring required

A unique ID for every single webhook request

timestampstring date-time required

The timestamp in ISO 8601 format that the webhook was sent at on the server

type'withdrawal.created' required

The webhook event type

Example payload

{
  "api_version": "v1",
  "api_version_date": "2026-07-20",
  "company_id": "biz_xxxxxxxxxxxxxx",
  "data": {
    "amount": 6.9,
    "created_at": "2023-12-01T05:00:00.401Z",
    "error_message": "Destination bank account is invalid.",
    "estimated_availability": "2023-12-01T05:00:00.401Z",
    "fee_amount": 6.9,
    "id": "wdrl_xxxxxxxxxxxxx",
    "ledger_account": {
      "id": "ldgr_xxxxxxxxxxxxx"
    },
    "markup_fee": 6.9,
    "payout_request_id": "cofr_xxxxxxxxxxxxxx",
    "payout_token": {
      "created_at": "2023-12-01T05:00:00.401Z",
      "destination_currency_code": "USD",
      "id": "potk_xxxxxxxxxxxxx",
      "nickname": "My Business Account",
      "payer_name": "Acme Corp LLC"
    },
    "trace_code": "021000021234567"
  },
  "id": "msg_xxxxxxxxxxxxxxxxxxxxxxxx",
  "timestamp": "2025-01-01T00:00:00.000Z",
  "type": "withdrawal.created"
}

Response

Return a 200 status to indicate that the data was received successfully