APIReferencia por operación
Cada operación de la API, con sus errores, reintentos, muestras y guías.
Cada operación tiene su página, que se lee sin JavaScript y existe también en Markdown. Para probarlas contra el simulador, usa la referencia interactiva. Todas juntas en texto: referencia en Markdown.
Cuenta
| Operación | Método y ruta |
|---|---|
| Saldos disponibles | GET /v1/balances |
| Límites de la cuenta | GET /v1/limits |
| Cuentas para recibir | GET /v1/receiving-accounts |
| Abrir una cuenta para recibir | POST /v1/receiving-accounts |
| Wallets de la empresa | GET /v1/wallets |
Beneficiarios
| Operación | Método y ruta |
|---|---|
| Beneficiarios | GET /v1/beneficiaries |
| Alta de beneficiario, pendiente de aprobar en el panel | POST /v1/beneficiaries |
| Un beneficiario | GET /v1/beneficiaries/{id} |
| Baja de beneficiario | DELETE /v1/beneficiaries/{id} |
Países del riel latam | GET /v1/latam/countries |
Bancos de un país del riel latam | GET /v1/latam/countries/{country}/entities |
Pagos
| Operación | Método y ruta |
|---|---|
| Pagos, con su último estado conocido | GET /v1/payments |
| Crear un pago | POST /v1/payments |
| Un pago | GET /v1/payments/{id} |
| Cancelar un pago que aún espera fondos | POST /v1/payments/{id}/cancel |
| Cotización indicativa con vencimiento | POST /v1/quotes |
Cobros
| Operación | Método y ruta |
|---|---|
| Métodos de cobro | GET /v1/collection-methods |
| Cobros, con su último estado conocido | GET /v1/collections |
| Crear un cobro | POST /v1/collections |
| Estimar un cobro | POST /v1/collections/estimate |
| Un cobro | GET /v1/collections/{id} |
Depósitos
| Operación | Método y ruta |
|---|---|
| Direcciones de depósito | GET /v1/deposit-addresses |
| Crear una dirección de depósito | POST /v1/deposit-addresses |
| Una dirección de depósito | GET /v1/deposit-addresses/{id} |
| Depósitos recibidos y quién pagó | GET /v1/deposits |
| Un depósito | GET /v1/deposits/{id} |
Movimientos
| Operación | Método y ruta |
|---|---|
| Movimientos de la cuenta | GET /v1/movements |
| Un movimiento | GET /v1/movements/{id} |
| Recibo de un movimiento terminal | GET /v1/movements/{id}/receipt |
Eventos
| Operación | Método y ruta |
|---|---|
| Eventos de la empresa | GET /v1/events |
| Un evento | GET /v1/events/{id} |
Webhooks
| Operación | Método y ruta |
|---|---|
| Destinos de webhooks | GET /v1/webhook-endpoints |
Sistema
| Operación | Método y ruta |
|---|---|
| Salud pública del servicio | GET /v1/health |
| IP de salida de webhooks | GET /v1/meta/egress-ips |
| Estado por capacidad | GET /v1/status |
Sandbox
| Operación | Método y ruta |
|---|---|
| Avanzar un pago ficticio | POST /sandbox/v1/payments/{id}/advance |
| Emitir un evento de prueba | POST /sandbox/v1/webhooks/trigger |