v1

latestOpenAPI 3.1.02026-07-241653251.3 MB

Withdrawals

Performs an UMA lookup prior to initiating a withdrawal

Verifies UMA address of a recipient and returns details of supported receiving currencies` (on Lightning Network).

get/withdrawals/umalookup/{recipient}

Path parameters

recipientstring required

The full UMA address of the withdrawal recipient.

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.

Response

Successfully retrieved UMA lookup result. including the list of currencies the recipient VASP can receive.

Example response

{
  "currencies": [
    {
      "code": "USD",
      "symbol": "$",
      "name": "US Dollars",
      "multiplier": "0.062",
      "decimals": 2,
      "min": "100",
      "max": "250000"
    }
  ]
}