Look up a UMA address for payment

curl --request GET \
  --url https://api.lightspark.com/grid/2025-10-13/receiver/uma/{receiverUmaAddress} \
  --header 'Authorization: Basic <encoded-value>'

{
  "supportedCurrencies": [
    {
      "currency": {
        "code": "USD",
        "name": "United States Dollar",
        "symbol": "$",
        "decimals": 2
      },
      "estimatedExchangeRate": 1.08,
      "min": 1,
      "max": 1000000
    }
  ],
  "lookupId": "Lookup:019542f5-b3e7-1d02-0000-000000000009",
  "receiverUmaAddress": "[email protected]",
  "requiredPayerDataFields": [
    {
      "name": "FULL_NAME",
      "mandatory": true
    }
  ]
}

GET

receiver

uma

{receiverUmaAddress}

Look up a UMA address for payment

curl --request GET \
  --url https://api.lightspark.com/grid/2025-10-13/receiver/uma/{receiverUmaAddress} \
  --header 'Authorization: Basic <encoded-value>'

{
  "supportedCurrencies": [
    {
      "currency": {
        "code": "USD",
        "name": "United States Dollar",
        "symbol": "$",
        "decimals": 2
      },
      "estimatedExchangeRate": 1.08,
      "min": 1,
      "max": 1000000
    }
  ],
  "lookupId": "Lookup:019542f5-b3e7-1d02-0000-000000000009",
  "receiverUmaAddress": "[email protected]",
  "requiredPayerDataFields": [
    {
      "name": "FULL_NAME",
      "mandatory": true
    }
  ]
}

Authorizations

Authorization

string

header

required

API token authentication using format <api token id>:<api client secret>

Path Parameters

receiverUmaAddress

string

required

UMA address of the intended recipient

Query Parameters

senderUmaAddress

string

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

customerId

string

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

Response

Successful lookup

supportedCurrencies

object[]

required

List of currencies supported by the receiving account

Show child attributes

supportedCurrencies.currency

object

required

Show child attributes

supportedCurrencies.currency.code

string

Three-letter currency code (ISO 4217) for fiat currencies. Some cryptocurrencies may use their own ticker symbols (e.g. "BTC" for Bitcoin, "USDC" for USDC, etc.)

Example:

"USD"

supportedCurrencies.currency.name

string

Full name of the currency

Example:

"United States Dollar"

supportedCurrencies.currency.symbol

string

Symbol of the currency

Example:

"$"

supportedCurrencies.currency.decimals

integer

Number of decimal places for the currency

Required range: x >= 0

Example:

2

supportedCurrencies.estimatedExchangeRate

number

required

An estimated exchange rate from the sender's currency to this currency. This is not a locked rate and is subject to change when calling the quotes endpoint.

Example:

1.08

supportedCurrencies.min

integer<int64>

required

The minimum amount that can be received in this currency.

Example:

1

supportedCurrencies.max

integer<int64>

required

The maximum amount that can be received in this currency.

Example:

1000000

lookupId

string

required

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

Example:

"Lookup:019542f5-b3e7-1d02-0000-000000000009"

receiverUmaAddress

string

required

The UMA address that was looked up

Example:

"[email protected]"

requiredPayerDataFields

object[]

Fields required by the receiving institution about the payer before payment can be completed

Show child attributes

requiredPayerDataFields.name

enum<string>

required

Name of a type of field containing info about a platform's customer or counterparty customer.

Available options:

FULL_NAME,

BIRTH_DATE,

NATIONALITY,

PHONE_NUMBER,

EMAIL,

POSTAL_ADDRESS,

TAX_ID,

REGISTRATION_NUMBER,

USER_TYPE,

COUNTRY_OF_RESIDENCE,

ACCOUNT_IDENTIFIER,

FI_LEGAL_ENTITY_NAME,

FI_ADDRESS,

PURPOSE_OF_PAYMENT,

ULTIMATE_INSTITUTION_COUNTRY,

IDENTIFIER

Example:

"FULL_NAME"

requiredPayerDataFields.mandatory

boolean

required

Whether the field is mandatory

Example:

true

Create a transfer-out request Look up an external account for payment

⌘I

Using the API

API documentation

Look up a UMA address for payment

Authorizations

Path Parameters

Query Parameters

Response