Skip to main content
GET
cURL

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)

sendingCurrency
string

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

sendingCurrency
object
required

The currency the payment is sent from — the sender's default, or the one named by the sendingCurrency query parameter. Every estimatedExchangeRate in supportedCurrencies converts from this currency, and any minSendingAmount/maxSendingAmount is denominated in its smallest unit.

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