Sign in
Cross-Currency Transfers

Look up an UMA address for payment

Lookup a receiving UMA address to determine supported currencies and exchange rates. This endpoint helps platforms determine what currencies they can send to a given UMA address.

get/receiver/uma/{receiverUmaAddress}

Path parameters

receiverUmaAddressstring required

UMA address of the intended recipient

Query parameters

senderUmaAddressstring

UMA address of the sender (optional if customerId is provided)

customerIdstring

System ID of the sender (optional if senderUmaAddress is provided)

sendingCurrencystring

Currency code the sender will send from (e.g., USD). Selects which of the sender's configured currencies the response is priced against: it is echoed back as the response's sendingCurrency, and the minSendingAmount/maxSendingAmount bounds are denominated in its smallest unit. Defaults to the sender's default currency.

Response

Successful lookup

lookupIdstring required

Unique identifier for the lookup. Needed in the subsequent create quote request.

receiverUmaAddressstring required

The UMA address that was looked up

Example response

{
  "sendingCurrency": {
    "code": "USD",
    "name": "United States Dollar",
    "symbol": "$",
    "decimals": 2
  },
  "supportedCurrencies": [
    {
      "currency": {
        "code": "USD",
        "name": "United States Dollar",
        "symbol": "$",
        "decimals": 2
      },
      "estimatedExchangeRate": 1.08,
      "min": 1,
      "max": 1000000,
      "minSendingAmount": 100,
      "maxSendingAmount": 500000
    }
  ],
  "requiredPayerDataFields": [
    {
      "name": "FULL_NAME",
      "mandatory": true
    }
  ],
  "lookupId": "Lookup:019542f5-b3e7-1d02-0000-000000000009",
  "receiverUmaAddress": "$receiver@uma.domain"
}

Changes