Sign in

v1

latestOpenAPI 3.1.02026-07-241653251.3 MB
Withdrawals

Request UMA Withdrawal

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

post/withdrawals/uma

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

participant_codestring

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

recipient_uma_addressstring

The UMA address of the recipient. (Required)

amount_satsstring

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

receiving_currencystring

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

amount_receiving_currencystring

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

client_withdrawal_request_idstring

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

Example request

{
  "participant_code": "D3SCYB",
  "recipient_uma_address": "$satoshi@vasp.com",
  "amount_sats": "1000",
  "receiving_currency": "SAT",
  "amount_receiving_currency": "1000",
  "client_withdrawal_request_id": "5c080f8a-f993-4cc4-9b33-326c4b765105"
}

Response

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

platform_codestring

zerohash platform code of the submitting platform.

participant_codestring

The participant code of the sender.

sender_uma_addressstring

The registered UMA address of the sender.

recipient_uma_addressstring

The UMA address of the recipient.

amount_satsstring

The amount to be sent specified in Satoshis.

sender_fee_satsstring

Satoshis charged (by zerohash and the estimated network fee) for the withdrawal.

receiving_currencystring

Currency to be received by the recipient (this is converted by the receiving VASP).

amount_receiving_currencystring

The final amount to be received in the 'receiving_currency'.

receiving_currency_multiplierstring

Satoshis per unit of receiving currency as quoted by the receiving VASP.

receiver_exchange_fee_satsstring

Satoshis to perform the currency exchange to 'receiving_currency' as quoted by the receiving VASP.

decimalsnumber

The number of digits after the decimal point for the receiving_currency

invoicestring

Bolt11 invoice for the withdrawal. This string can be submitted to 'POST /withdrawals/requests' as a 'destination_address' to initiate payment.

payee_namestring

The name of the payee receiving the withdrawal.

payee_emailstring

The email address of the payee receiving the withdrawal.

Example response

{
  "platform_code": "JDNQGG",
  "participant_code": "D3SCYB",
  "sender_uma_address": "$sender@uma.zerohash.id",
  "recipient_uma_address": "$satoshi@vasp.com",
  "amount_sats": "900",
  "sender_fee_sats": "179",
  "receiving_currency": "SAT",
  "amount_receiving_currency": "900",
  "receiving_currency_multiplier": "1.000000000",
  "receiver_exchange_fee_sats": "100",
  "invoice": "lnbcrt...nvrx9",
  "payee_name": "John Doe",
  "payee_email": "john.doe@example.com"
}