v5

OpenAPI 3.1.0Proprietary2026-08-011476181.4 MB

Cross-Currency Transfers

Look up an external account for payment

Lookup an external account by ID to determine supported currencies and exchange rates. This endpoint helps platforms determine what currencies they can send to a given external account, along with the current estimated exchange rates and minimum and maximum amounts that can be sent.

get/receiver/external-account/{accountId}

Path parameters

accountIdstring required

Example:ExternalAccount:e85dcbd6-dced-4ec4-b756-3c3a9ea3d965

System-generated ID of the external account

Query parameters

senderUmaAddressstring

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

customerIdstring

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

Response

Successful lookup

lookupIdstring required

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

accountIdstring required

The external account ID that was looked up

Example response

{
  "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",
  "accountId": "ExternalAccount:e85dcbd6-dced-4ec4-b756-3c3a9ea3d965"
}