Sign in

v1

latestOpenAPI 3.1.02026-07-241653251.3 MB
Withdrawals

Execute withdrawal

Executes a withdrawal that has been previously quoted.

post/withdrawals/execute

Headers

X-SCX-SIGNEDstring required

HMAC-SHA256 signature of the request, base64-encoded. See the Authentication guide for the exact signing formula.

X-SCX-TIMESTAMPstring required
Example:1678901234

Current Unix timestamp in seconds. Must be within 60 seconds of server time or the request is rejected.

Request body

withdrawal_quote_idstring

The unique id associated with a locked network fee quote

client_withdrawal_request_idstring

A unique id for the withdrawal produced by the Platform

beneficiary_participant_codestring

The identifier of the participant benefiting from the withdrawal request

beneficiary_first_namestring

The first name of the participant benefiting from the quote request Only applies to individual beneficiaries. Cannot be used along with business_beneficiary_name. Note: Redundant if beneficiary_participant_code is provided in request

beneficiary_last_namestring

The last name of the participant benefiting from the quote request Only applies to individual beneficiaries. Cannot be used along with business_beneficiary_name. Note: Redundant if beneficiary_participant_code is provided in request

beneficiary_business_namestring

The name of the the business participant benefiting from the quote request Only applies to business beneficiaries. Cannot be used along with first/last_beneficiary_name. Note: Redundant if beneficiary_participant_code is provided in request

Response

Successfully executed withdrawal.

Example response

{
  "message": {
    "request_id": "81904785-c092-41cd-9497-9198749e1b67",
    "withdrawal_quote_id": "bdc4c936-8505-4e61-b859-f3a5a6bdc880",
    "withdrawal_request_id": "ffbfce91-8256-47b5-b079-e12a2c0198a2",
    "participant_code": "ABCDEF",
    "account_group": "JMCH0H",
    "account_label": "general",
    "withdrawal_address": "bc1qy08yh0cm565gvtx2z80dz6dnyr635mwtknl36e",
    "withdrawal_account_id": "146",
    "asset": "BTC",
    "amount": "0.04867615",
    "amount_notional": "3832.51",
    "network_fee": "0.00000282",
    "network_fee_notional": "0.22",
    "on_chain_status": "PENDING",
    "withdrawal_fee": "0"
  }
}