Execute withdrawal

post

https://api.cert.zerohash.com/withdrawals/execute

Executes a withdrawal that has been previously quoted.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Withdrawal execution details including quote ID and confirmation.

withdrawal_quote_id

string

The unique id associated with a locked network fee quote

client_withdrawal_request_id

string

A unique id for the withdrawal produced by the Platform

beneficiary_participant_code

string

The identifier of the participant benefiting from the withdrawal request

beneficiary_first_name

string

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_name

string

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_name

string

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

Headers

X-SCX-SIGNED

string

required

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

X-SCX-TIMESTAMP

string

required

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

Responses

200Successfully executed withdrawal.

400Bad Request

403Forbidden

404Not Found

500Internal Server Error

503Service Unavailable