---
title: "Request UMA Withdrawal"
method: POST
path: "/withdrawals/uma"
tags: ["Withdrawals"]
---

# Request UMA Withdrawal

`POST /withdrawals/uma`

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

## Headers

- `X-SCX-SIGNED` string, required
- `X-SCX-TIMESTAMP` string, required

## Request body

- WithdrawalUmaRequest
  - `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)

## Response `200`

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

- WithdrawalUmaResponse
  - `platform_code` string — zerohash platform code of the submitting platform.
  - `participant_code` string — The participant code of the sender.
  - `sender_uma_address` string — The registered UMA address of the sender.
  - `recipient_uma_address` string — The UMA address of the recipient.
  - `amount_sats` string — The amount to be sent specified in Satoshis.
  - `sender_fee_sats` string — Satoshis charged (by zerohash and the estimated network fee) for the withdrawal.
  - `receiving_currency` string — Currency to be received by the recipient (this is converted by the receiving VASP).
  - `amount_receiving_currency` string — The final amount to be received in the 'receiving_currency'.
  - `receiving_currency_multiplier` string — Satoshis per unit of receiving currency as quoted by the receiving VASP.
  - `receiver_exchange_fee_sats` string — Satoshis to perform the currency exchange to 'receiving_currency' as quoted by the receiving VASP.
  - `decimals` number — The number of digits after the decimal point for the receiving_currency
  - `invoice` string — Bolt11 invoice for the withdrawal. This string can be submitted to 'POST /withdrawals/requests' as a 'destination_address' to initiate payment.
  - `payee_name` string — The name of the payee receiving the withdrawal.
  - `payee_email` string — The email address of the payee receiving the withdrawal.

## Other responses

- `400` — Bad Request
- `403` — Forbidden
- `404` — Not Found
- `500` — Internal Server Error
- `503` — Service Unavailable

---

[API](https://skmtc.net/zerohash/apis/zerohash-api.md) · [All operations](https://skmtc.net/zerohash/apis/zerohash-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/zerohash/zerohash-api/revisions/8b647d934363/schema)