Available UMA Providers

This endpoint provides a list of counterparties that are available.

The response includes basic information about each provider, such as its UMA address, name, and supported currencies. This can be used to determine which providers are available for sending or receiving payments.

get/uma-providers

Query parameters

countryCodestring

Example:US

The alpha-2 representation of a country, as defined by the ISO 3166-1 standard.

currencyCodestring

Example:USD

The ISO 4217 currency code to filter providers by supported currency.

hasBlockedProvidersboolean

Whether to include providers which are not on your allowlist in the response. By default the response will include blocked providers.

limitinteger

Maximum number of results to return (default 20, max 100)

cursorstring

Cursor for pagination (returned from previous request)

sortOrder'asc' | 'desc'

Order to sort results in

Response

Successful operation

hasMoreboolean

Indicates if more results are available beyond this page

nextCursorstring

Cursor to retrieve the next page of results (only present if hasMore is true)

totalCountinteger

Total number of transactions matching the criteria (excluding pagination)

Example response

{
  "data": [
    {
      "name": "Lightspark Group",
      "supportedRegions": [
        "US"
      ],
      "domain": "uma.me",
      "logoUrl": "https://uma.me/logo.png",
      "supportedCurrencies": [
        {
          "code": "USD",
          "name": "United States Dollar",
          "symbol": "$",
          "decimals": 2
        }
      ],
      "lei": "5493001KJTIIGC8Y1R12",
      "allowListStatus": true
    }
  ]
}

Changes

No changes recorded. 1 of the 13 revisions has no diff computed, so it could not be searched.