Request UMA Withdrawal

post

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

Requests a withdrawal to an UMA address (on Lightning Network).

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

UMA withdrawal request details including UMA address and amount.

participant_code

string

The participant code against whom the withdrawal will be made.
Note: this participant should have an existing UMA address. (Required)

recipient_uma_address

string

The UMA address of the recipient. (Required)

amount_sats

string

The amount to be sent specified in Satoshis. (Optional)

receiving_currency

string

If specified, the receiving VASP will convert the incoming BTC into this currency. (Optional)

amount_receiving_currency

string

The amount to be sent specified in the smallest unit of the receiving currency (eg. cents for USD). (Optional)

client_withdrawal_request_id

string

A unique identifier for the withdrawal produced by the Platform. (Optional)

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

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successfully created UMA withdrawal request. Returns the created resource with generated IDs and timestamps.