Skip to main content
POST

Authorizations

x-api-key
string
header
required

Path Parameters

subaccountId
string
required

Body

application/json

Requires approved KYC. payment_rail is USD-only and supports RTP, WIRE, SWIFT, SAME_DAY_ACH, and ACH. Set named_withdrawal to true only for USD named withdrawals. Named withdrawals require a business recipient identified by business_name and the recipient must include beneficiary_date_of_formation, beneficiary_country_of_formation, and beneficiary_national_identification_number. Named withdrawals support only WIRE and SWIFT. RTP, SAME_DAY_ACH, and ACH remain supported only for non-named USD flows where applicable.

recipient_id
string
required
amount
string
required
currency
enum<string>
required
Available options:
USD
wire_message
string
client_reference
string

Optional client-provided reference for reconciliation.

payment_rail
enum<string>

USD-only payment rail. For named withdrawals, only WIRE and SWIFT are supported. RTP, SAME_DAY_ACH, and ACH are for non-named USD flows where applicable.

Available options:
RTP,
WIRE,
SWIFT,
SAME_DAY_ACH,
ACH
named_withdrawal
boolean

Set to true for a USD named withdrawal. Named withdrawals require a business recipient with business_name and the three beneficiary fields, and support only WIRE and SWIFT.

origin_id
string

Optional unique client-provided reference for reconciliation.

Response

Withdrawal initiated successfully

id
string<uuid>
amount
string
currency
string
status
string
created_at
string<date-time>
client_reference
string<uuid>
protocol
string
description
string | null
local_currency
string
local_amount
number
destinationAddress
string | null
tx_hash
string | null
destination_tag
string | null
fee_amount
string
fee_currency
string
rate
number
gross_amount
number
net_amount
number