Skip to main content
GET
Which ways in and out are open for a country
Currently being connected, docs updating. This endpoint answers mock: true: ids, shapes and statuses are real and deterministic from your input, every money figure is the placeholder 1234567.89, and nothing is sent to a provider. Integrate against the shape; do not compute anything from the figures.

Authorizations

Authorization
string
header
required

Your API key, issued by us and shown once at creation.

Query Parameters

country
string
required

ISO 3166-1 alpha-2 code of the country (case-insensitive).

Pattern: ^[A-Za-z]{2}$
Example:

"BR"

direction
enum<string>

in for money coming in, out for payouts. Omit for both.

Available options:
in,
out
Example:

"out"

currency
string

Narrow the answer to one ISO 4217 currency (case-insensitive).

Pattern: ^[A-Za-z]{3}$
Example:

"BRL"

Response

The methods, narrowed to this key.

What can move in and out of a country, for this key. A method listed is what the corridor supports, not pre-approval of a user.

environment
enum<string>
required

Which environment answered. sandbox: at least one money upstream is the provider's sandbox - no real money moves there, and the card corridor is the sandbox's asset (read GET /v1/config), not the documented production one. production: every configured upstream is real. Derived from the configured upstream hosts at boot, never a flag.

Available options:
sandbox,
production
Example:

"sandbox"

mock
boolean
required

Always true on this endpoint: the provider behind it is currently being connected, docs updating. Ids, shapes and statuses are real and deterministic from your input; every money figure is the placeholder 1234567.89; nothing is sent to a provider. The field disappears the day the provider is wired, so branch on its presence, not its value.

Example:

true

country
string
required

The country asked about, upper-cased.

Example:

"BR"

methods
object[]
required

One entry per method, direction and currency - narrowed to the products YOUR key carries, so a key without cards never sees a card entry. Empty for a country we cannot onboard, and for a key with no product that has a payment method.