Skip to main content
WEBHOOK
withdrawal.updated
{
  "id": "msg_xxxxxxxxxxxxxxxxxxxxxxxx",
  "api_version": "v1",
  "timestamp": "2025-01-01T00:00:00.000Z",
  "type": "withdrawal.updated",
  "data": {
    "id": "wdrl_xxxxxxxxxxxxx",
    "status": "requested",
    "amount": 6.9,
    "currency": "usd",
    "fee_amount": 6.9,
    "fee_type": "exclusive",
    "speed": "standard",
    "created_at": "2023-12-01T05:00:00.401Z",
    "markup_fee": 6.9,
    "ledger_account": {
      "id": "ldgr_xxxxxxxxxxxxx",
      "company_id": "<string>"
    },
    "payout_token": {
      "id": "potk_xxxxxxxxxxxxx",
      "payer_name": "Acme Corp LLC",
      "nickname": "My Business Account",
      "destination_currency_code": "USD",
      "created_at": "2023-12-01T05:00:00.401Z"
    },
    "error_code": "account_closed",
    "error_message": "Destination bank account is invalid.",
    "estimated_availability": "2023-12-01T05:00:00.401Z",
    "trace_code": "021000021234567"
  },
  "company_id": "biz_xxxxxxxxxxxxxx"
}

Headers

​
webhook-id
string
required

A unique identifier for this webhook request

Example:

"msg_xxxxxxxxxxxxxxxxxxxxxxxx"

​
webhook-signature
string
required

The signature of the webhook request with the webhook version prepended

Example:

"v1,BASE64ENCODEDSIGNATURE"

​
webhook-timestamp
string
required

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

Example:

"1727606400"

Body

application/json
​
id
string
required

A unique ID for every single webhook request

Example:

"msg_xxxxxxxxxxxxxxxxxxxxxxxx"

​
api_version
string
required

The API version for this webhook

Allowed value: "v1"
Example:

"v1"

​
timestamp
string<date-time>
required

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

Example:

"2025-01-01T00:00:00.000Z"

​
type
string
required

The webhook event type

Allowed value: "withdrawal.updated"
Example:

"withdrawal.updated"

​
data
object
required

A withdrawal represents a request to transfer funds from a ledger account to an external payout method.

​
company_id
string | null

The company ID that this webhook event is associated with

Example:

"biz_xxxxxxxxxxxxxx"

Response

200

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