Catalog

The catalog says what you can do today with your key. Read it on startup and whenever config_version changes; don’t hard-code it.

• GET /v2/capabilities: everything together: countries, currencies, pay-in and payout methods per country with their fields (fields), limits (min_amount, max_amount), availability and, for incoming pay-ins (incoming_*), the receiving account (receiving_account) you show your payer.
• GET /v2/methods?country=&direction=: just the methods.
• GET /v2/banks?country=&method=: a country’s banks with the methods they support today. It never says through which provider.

Availability

• available
• temporarily_unavailable
• disabled

A temporarily_unavailable method comes back on its own; a disabled one was switched off by an operator. Creating an operation with an unavailable method gets 503 temporarily_unavailable or 400 method_unavailable.

Routes

Your balances per currency

GET/v2/balances

Scopesaldos:leer

Per currency: available and reserved. Requires the saldos:leer scope.

Code	Meaning
200	The balances.
401	The key is missing or invalid. Codes: unauthorized.
403	The key is valid but lacks the scope. Codes: scope_missing.

A country’s banks

GET/v2/banks

Scope: any valid key

With code, name and which methods each one supports today. Requires a valid key, no particular scope.

Parameter	In	Required	Description
country	query	yes	ISO 3166-1 alpha-2.
method	query	no	Only banks that support this method.

Code	Meaning
200	The banks.
400	An invalid or missing parameter. Codes: country_unsupported, field_required, method_unavailable.
401	The key is missing or invalid. Codes: unauthorized.

What your key can do today

GET/v2/capabilities

Scope: any valid key

Countries, currencies, methods per direction with their fields, limits and availability, and config_version. It is the only source you need to read to know what you can do today.

Requires a valid key, no particular scope.

Code	Meaning
200	The capabilities.
401	The key is missing or invalid. Codes: unauthorized.

The method catalog

GET/v2/methods

Scope: any valid key

Filterable by country and direction. Requires a valid key, no particular scope.

Parameter	In	Required	Description
country	query	no	ISO 3166-1 alpha-2. Without it, every country.
direction	query	no	Without it, both directions.

Code	Meaning
200	The methods.
400	An invalid parameter. Codes: country_unsupported, field_invalid.
401	The key is missing or invalid. Codes: unauthorized.

The shapes

Field	Type	Required	Description
availability	Disponibilidad	yes
code	CodigoDeMetodo	yes
country	string	yes
currency	string	yes
direction	payin | payout	yes
fields	array<Campo>	yes	What payer (or beneficiary) has to carry for this method.
max_amount	string | null	yes	null = no cap.
min_amount	string	yes
name	string	yes
receiving_account	CuentaReceptora | null	no	Incoming pay-ins only: where your payer has to pay. Show it as is. Absent if not loaded yet.

A fields entry

Field	Type	Required	Description
enum	array<string>	no
example	string	no
name	string	yes	The path inside payer, dot-separated for nested fields.
pattern	string	no
required	boolean	yes
type	string | enum | date	yes

The receiving account (incoming_* only)

Field	Type	Required	Description
account_number	string	no	incoming_transfer only: the 20-digit account.
bank_code	string	yes	The bank of the receiving account.
document	string	yes	The holder’s document, as the sending bank asks for it.
holder	string	yes	The holder’s name.
phone	string	no	incoming_mobile_payment only: the phone the mobile payment is sent to.

Bank

Field	Type	Required	Description
code	string	yes
methods	array<CodigoDeMetodo>	yes	The ones it supports today.
name	string	yes

Balance

Field	Type	Required	Description
available	string	yes
currency	string	yes
reserved	string	yes