Skip to main content
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
    }
  ],
  "requiredPayerDataFields": [
    {
      "name": "FULL_NAME",
      "mandatory": true
    }
  ],
  "lookupId": "Lookup:019542f5-b3e7-1d02-0000-000000000009",
  "receiverUmaAddress": "$receiver@uma.domain"
}

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

​
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:

"$receiver@uma.domain"

​
requiredPayerDataFields
object[]

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

⌘I