Withdrawal created

Headers

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

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.created"

Example:

"withdrawal.created"

data

object

required

A withdrawal request.

Show child attributes

data.id

string

required

Internal ID of the withdrawal request.

Example:

"wdrl_xxxxxxxxxxxxx"

data.status

enum<string>

required

Status of the withdrawal.

Available options:

requested,

awaiting_payment,

in_transit,

completed,

failed,

canceled,

denied

data.amount

number

required

How much money was attempted to be withdrawn, in a float type.

Example:

6.9

data.currency

enum<string>

required

The currency of the withdrawal request.

Available options:

usd,

sgd,

inr,

aud,

brl,

cad,

dkk,

eur,

nok,

gbp,

sek,

chf,

hkd,

huf,

jpy,

mxn,

myr,

pln,

czk,

nzd,

aed,

eth,

ape,

cop,

ron,

thb,

bgn,

idr,

dop,

php,

try,

krw,

twd,

vnd,

pkr,

clp,

uyu,

ars,

zar,

dzd,

tnd,

mad,

kes,

kwd,

jod,

all,

xcd,

amd,

bsd,

bhd,

bob,

bam,

khr,

crc,

xof,

egp,

etb,

gmd,

ghs,

gtq,

gyd,

ils,

jmd,

mop,

mga,

mur,

mdl,

mnt,

nad,

ngn,

mkd,

omr,

pyg,

pen,

qar,

rwf,

sar,

rsd,

lkr,

tzs,

ttd,

uzs,

rub,

btc,

cny

data.fee_amount

number

required

The fee amount that was charged for the withdrawal. This is in the same currency as the withdrawal amount.

Example:

6.9

data.fee_type

enum<string> | null

required

The type of fee that was charged for the withdrawal.

Available options:

exclusive,

inclusive

data.withdrawal_type

enum<string>

required

The type of withdrawal.

Available options:

regular,

clawback

data.speed

enum<string>

required

The speed of the withdrawal.

Available options:

standard,

instant

data.created_at

string<date-time>

required

When the withdrawal request was created.

Example:

"2023-12-01T05:00:00.401Z"

data.ledger_account

object

required

The ledger account associated with the withdrawal.

Show child attributes

data.ledger_account.id

string

required

The ID of the LedgerAccount.

Example:

"ldgr_xxxxxxxxxxxxx"

data.ledger_account.company_id

string | null

required

The ID of the company associated with this ledger account.

data.payout_token

object

required

The payout token used for the withdrawal, if applicable.

Show child attributes

data.payout_token.id

string

required

The ID of the payout token

Example:

"potk_xxxxxxxxxxxxx"

data.payout_token.payer_name

string | null

required

The name of the payer associated with the payout token.

data.payout_token.nickname

string | null

required

An optional nickname for the payout token to help the user identify it. This is not used by the provider and is only for the user's reference.

data.payout_token.destination_currency_code

string

required

The currency code of the payout destination. This is the currency that payouts will be made in for this token.

data.payout_token.created_at

string<date-time>

required

The date and time the payout token was created

Example:

"2023-12-01T05:00:00.401Z"

data.error_code

enum<string> | null

required

The error code associated with the withdrawal, if any.

Available options:

account_closed,

account_does_not_exist,

account_information_invalid,

account_number_invalid_region,

account_frozen,

account_lookup_failed,

account_not_found,

amount_out_of_bounds,

attributes_not_validated,

b2b_payments_prohibited,

bank_statement_required,

compliance_review,

currency_not_supported,

deposit_canceled,

deposit_failed,

deposit_rejected,

destination_unavailable,

exceeded_account_limit,

expired_quote,

generic_payout_error,

technical_problem,

identification_number_invalid,

invalid_account_number,

invalid_bank_code,

invalid_beneficiary,

invalid_branch_number,

invalid_branch_code,

invalid_phone_number,

invalid_routing_number,

invalid_swift_code,

invalid_company_details,

manual_cancelation,

misc_error,

missing_city_and_country,

missing_phone_number,

missing_remittance_info,

payee_name_invalid,

receiving_account_locked,

rejected_by_compliance,

rtp_not_supported,

non_transaction_account,

source_token_insufficient_funds,

ssn_invalid,

wallet_screenshot_required,

unsupported_region

data.error_message

string | null

required

The error message for the withdrawal, if any.

data.estimated_availability

string<date-time> | null

required

The estimated availability date for the withdrawal, if any.

Example:

"2023-12-01T05:00:00.401Z"

data.trace_code

string | null

required

The trace code for the payout, if applicable. Provided on ACH transactions when available.

Response

200

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

Introduction

Payins

Payouts

Identity

CRM

Engagement

Courses

Developer

Withdrawal created

Headers

Body

Response