Catálogo

El catálogo dice qué se puede hacer hoy con su llave. Léalo al arrancar y cuando cambie config_version; no lo escriba en su código.

• GET /v2/capabilities: todo junto: países, monedas, métodos de cobro y de pago por país con sus campos (fields), límites (min_amount, max_amount), disponibilidad y, en los cobros recibidos (incoming_*), la cuenta receptora (receiving_account) que usted le muestra a su pagador.
• GET /v2/methods?country=&direction=: sólo los métodos.
• GET /v2/banks?country=&method=: los bancos de un país con los métodos que admiten hoy. Nunca dice por qué proveedor.

Disponibilidad

• available
• temporarily_unavailable
• disabled

Un método temporarily_unavailable vuelve solo; uno disabled lo apagó un operador. Crear una operación con un método no disponible es 503 temporarily_unavailable o 400 method_unavailable.

Rutas

Sus saldos por moneda

GET/v2/balances

Alcancesaldos:leer

Por moneda: available y reserved. Requiere el alcance saldos:leer.

Código	Significa
200	Los saldos.
401	La llave falta o no es válida. Códigos: unauthorized.
403	La llave es válida pero no tiene el alcance. Códigos: scope_missing.

Los bancos de un país

GET/v2/banks

Alcance: cualquier llave válida

Con code, name y qué métodos admite hoy cada uno. Requiere una llave válida, sin alcance particular.

Parámetro	En	Obligatorio	Descripción
country	query	sí	ISO 3166-1 alfa-2.
method	query	no	Sólo los bancos que admiten este método.

Código	Significa
200	Los bancos.
400	Un parámetro inválido o faltante. Códigos: country_unsupported, field_required, method_unavailable.
401	La llave falta o no es válida. Códigos: unauthorized.

Qué puede hacer su llave hoy

GET/v2/capabilities

Alcance: cualquier llave válida

Países, monedas, métodos por dirección con sus campos, límites y disponibilidad, y config_version. Es la única fuente que necesita leer para saber qué puede hacer hoy.

Requiere una llave válida, sin alcance particular.

Código	Significa
200	Las capacidades.
401	La llave falta o no es válida. Códigos: unauthorized.

El catálogo de métodos

GET/v2/methods

Alcance: cualquier llave válida

Filtrable por país y dirección. Requiere una llave válida, sin alcance particular.

Parámetro	En	Obligatorio	Descripción
country	query	no	ISO 3166-1 alfa-2. Sin él, todos los países.
direction	query	no	Sin él, las dos direcciones.

Código	Significa
200	Los métodos.
400	Un parámetro inválido. Códigos: country_unsupported, field_invalid.
401	La llave falta o no es válida. Códigos: unauthorized.

Las formas

Campo	Tipo	Obligatorio	Descripción
availability	Disponibilidad	sí
code	CodigoDeMetodo	sí
country	string	sí
currency	string	sí
direction	payin | payout	sí
fields	array<Campo>	sí	Lo que payer (o beneficiary) tiene que traer para este método.
max_amount	string | null	sí	null = sin tope.
min_amount	string	sí
name	string	sí
receiving_account	CuentaReceptora | null	no	Sólo cobros recibidos: adónde tiene que pagar su pagador. Muéstreselo tal cual. Ausente si todavía no está cargada.

Un campo de fields

Campo	Tipo	Obligatorio	Descripción
enum	array<string>	no
example	string	no
name	string	sí	La ruta dentro de payer, con punto para los anidados.
pattern	string	no
required	boolean	sí
type	string | enum | date	sí

La cuenta receptora (sólo incoming_*)

Campo	Tipo	Obligatorio	Descripción
account_number	string	no	Sólo incoming_transfer: la cuenta de 20 dígitos.
bank_code	string	sí	El banco de la cuenta receptora.
document	string	sí	El documento del titular, como lo pide el banco emisor.
holder	string	sí	El nombre del titular.
phone	string	no	Sólo incoming_mobile_payment: el teléfono al que se manda el Pago Móvil.

Banco

Campo	Tipo	Obligatorio	Descripción
code	string	sí
methods	array<CodigoDeMetodo>	sí	Los que admite hoy.
name	string	sí

Saldo

Campo	Tipo	Obligatorio	Descripción
available	string	sí
currency	string	sí
reserved	string	sí