ALalfredpay
Onboarding

Get one country's currencies, routes and requirements

Changed on

The country is the resource. Everything you need to move money in or out of it comes back from this one read, with no query parameters.

routes[] is the route registry. Each entry is a supported combination of currency, destination type and rail, and carries:

  • which operations it supports, PAYOUT or COLLECTION
  • the identifier fields to collect when registering a destination of that kind
  • whether a payout on it needs a quote
  • its status, one of LIVE, SANDBOX or TARGET

A combination that isn't LIVE is refused with route_unsupported before anything is locked, at registration, at quote and at payout. You'll never discover it at settlement.

Wallet destinations have no country and don't appear here. A stablecoin wallet is registered with chain and address only, and is reachable on the WALLET rail for every chain in Chain.

Read each country once when you integrate, then again whenever country.route.updated fires. Providers and account identifiers are never part of a route.

Wait on country.route.updated to know when a route changes. See Webhooks and events.

get/v1/countries/{country}

Request

  • Base URL
    https://api.sandbox.alfredpay.io
  • URL
    https://api.sandbox.alfredpay.io/v1/countries/{country}
  • Auth
    • HTTP bearer
    • or API key in header api-key and API key in header api-secret

Path parameters

country'MEX' | 'ARG' | 'BRA' | 'COL' | 'CHL' | 'PER' | 'DOM' | 'USA' | 'CHN' | 'HKG' | 'BOL' | 'PRY' required

ISO 3166-1 alpha-3, the only form Alfred stores, filters on, reports or emits. Compatibility rule for integrations that can only send alpha-2: any inbound country value in alpha-2 (path, query or body) is normalized to alpha-3 at the boundary before validation, storage or routing. Unrecognized in either form → 422 validation_error.

Response

OK

code'MEX' | 'ARG' | 'BRA' | 'COL' | 'CHL' | 'PER' | 'DOM' | 'USA' | 'CHN' | 'HKG' | 'BOL' | 'PRY'

ISO 3166-1 alpha-3, the only form Alfred stores, filters on, reports or emits. Compatibility rule for integrations that can only send alpha-2: any inbound country value in alpha-2 (path, query or body) is normalized to alpha-3 at the boundary before validation, storage or routing. Unrecognized in either form → 422 validation_error.

namestring
currenciesCurrency[]
localStablecoin'MXNa' | 'ARSa' | 'COPa' | 'BRZ' | 'null' nullable

Changes