Sign in
Sending Payments

Look up a 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/{receiverUmaAddress}

Path parameters

receiverUmaAddressstring required

UMA address of the intended recipient

Query parameters

senderUmaAddressstring

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

userIdstring

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

Response

Successful lookup

receiverUmaAddressstring required

The UMA address that was looked up

lookupIdstring required

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

kycStatus'UNKNOWN' | 'NOT_VERIFIED' | 'PENDING' | 'VERIFIED' required

KYC status of the customer. This field describes whether the UMA provider is doing a full KYC check on the customer. Note that in cases where the UMA provider is proxying to an underlying bank account, the bank will still have KYC'd the customer. See bankAccountNameMatchingStatus for cases where there's a backing bank account, but the UMA provider is able to verify the account holder's name.

bankAccountNameMatchingStatus'UNKNOWN' | 'NOT_MATCHED' | 'MATCHED'

Status of the bank account name matching. This field describes whether the UMA provider is able to verify that a backing bank account holder's name matches the name provided as payee data in the payreq response if applicable. It ensures that the ultimate landing destination of the payment is the intended payee. Note that this field is only applicable if the UMA provider is proxying to an underlying bank account.

Example response

{
  "receiverUmaAddress": "$receiver@uma.domain",
  "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",
  "kycStatus": "VERIFIED",
  "bankAccountNameMatchingStatus": "MATCHED"
}

Changes

Changed in 4 of the 13 revisions of this API.33

  • 2e2b5ba6d69b1See the full diff
    • ●

      added the new BUSINESS_TYPE enum value to the requiredPayerDataFields/items/name response property for the response status 200

      response-property-enum-value-added

  • 5ba7ef54f5e72See the full diff
    • ○

      added the optional property bankAccountNameMatchingStatus to the response with the 200 status

      response-optional-property-added

    • ○

      added the required property kycStatus to the response with the 200 status

      response-required-property-added

  • 5aa85b5719f81See the full diff
    • ●

      added the new IDENTIFIER enum value to the requiredPayerDataFields/items/name response property for the response status 200

      response-property-enum-value-added

  • 67d024304d3811See the full diff
    • ●

      added the new POSTAL_ADDRESS enum value to the requiredPayerDataFields/items/name response property for the response status 200

      response-property-enum-value-added

    • ○

      removed the ADDRESS enum value from the requiredPayerDataFields/items/name response property for the response status 200

      response-property-enum-value-removed

Of the 13 revisions, 1 has no diff computed.