API reference
Explore the deployed OpenAPI schema, interactive Scalar reference, and every tenant endpoint.
Live contract
The portal publishes a downloadable OpenAPI contract at /openapi.json and an interactive Scalar explorer at /api-reference (also available on the API host at /reference). Every request and response schema below is generated from NestJS decorators — prefer Scalar when you need field-level types, examples, and try-it requests.
All tenant endpoints
Complete method × path matrix for the tenant API. Open /api-reference and select an operation for full request/response schemas.
| Method | Path | Tag | Purpose |
|---|---|---|---|
| GET | /v1/banks | Banks | Listed bank catalog (code, name, services, logoUrl) |
| GET | /v1/quote?usdAmount= | Payments | BCV quote (settlement + median rates) |
| POST | /v1/payments/c2p/request | Payments | Create C2P intent + request bank OTP when supported |
| POST | /v1/payments/c2p | Payments | Execute C2P charge with customer token |
| POST | /v1/payments/vpos | Payments | VPOS card charge (BNC, PCI server only) |
| POST | /v1/payments/pago-movil/verify | Payments | Verify customer Pago Móvil reference (BNC or R4) |
| GET | /v1/payments/by-ref/:externalRef | Payments | Latest payment by correlation ref |
| GET | /v1/payments/:id | Payments | Payment receipt by id |
| POST | /v1/payments/:id/reverse | Payments | Reverse a completed C2P payment |
| POST | /v1/payments/debit/otp | Advanced payments | Request débito inmediato OTP (VES) |
| POST | /v1/payments/debit | Advanced payments | Execute débito inmediato |
| GET | /v1/payments/operations/:id | Advanced payments | Poll pending network operation |
| POST | /v1/payments/credit | Advanced payments | Immediate credit by phone |
| POST | /v1/payments/credit/account | Advanced payments | Credit a 20-digit account |
| POST | /v1/payments/credit/disburse | Advanced payments | Disburse inbound Pago Móvil by phone |
| POST | /v1/payments/payouts | Advanced payments | Account-based multi-beneficiary dispersion |
| POST | /v1/payments/change | Advanced payments | Send change (vuelto) to customer |
| POST | /v1/merchants | Merchants | Register merchant (+ optional first payout method) |
| GET | /v1/merchants | Merchants | List merchants or lookup by externalRef |
| GET | /v1/merchants/:id | Merchants | Merchant details + payout methods |
| PATCH | /v1/merchants/:id | Merchants | Activate / deactivate merchant |
| DELETE | /v1/merchants/:id | Merchants | Hard-delete when no payout history |
| GET | /v1/merchants/:id/payout-methods | Merchants | List Pago Móvil payout methods |
| POST | /v1/merchants/:id/payout-methods | Merchants | Add a payout method |
| POST | /v1/merchants/:id/payout-methods/:methodId/default | Merchants | Set default payout method |
| DELETE | /v1/merchants/:id/payout-methods/:methodId | Merchants | Delete a payout method |
| POST | /v1/merchants/:id/payout-methods/:methodId/verify/start | Merchants | Start micro-deposit verification |
| POST | /v1/merchants/:id/payout-methods/:methodId/verify | Merchants | Confirm micro-deposit amounts |
| POST | /v1/merchants/:id/verify/start | Merchants | Legacy: verify default method |
| POST | /v1/merchants/:id/verify | Merchants | Legacy: confirm default method |
| POST | /v1/payouts | Payouts | Create single merchant payout (idempotent) |
| POST | /v1/payouts/batch | Payouts | Split batch with per-item results |
| GET | /v1/payouts | Payouts | List payouts (cursor pagination) |
| GET | /v1/payouts/by-ref/:externalRef | Payouts | Payout by externalRef |
| GET | /v1/payouts/:id | Payouts | Payout by id |
| POST | /v1/webhooks | Webhooks | Register endpoint (secret returned once) |
| GET | /v1/webhooks | Webhooks | List endpoints (secrets omitted) |
| PATCH | /v1/webhooks/:id | Webhooks | Update url / events / active |
| DELETE | /v1/webhooks/:id | Webhooks | Delete endpoint + delivery history |
| POST | /v1/notifications/test | Webhooks | Send notification.test to subscribers |
AI / LLM Markdown
If you are wiring an AI coding agent or RAG pipeline, prefer these Markdown surfaces over scraping HTML. They follow the llms.txt convention.
| URL | Purpose |
|---|---|
| /llms.txt | Curated index of docs with links to Markdown pages |
| /llms-full.txt | Entire English guide concatenated into one Markdown file |
| /{slug}.md | Single guide page as clean Markdown (e.g. /merchants-payouts.md) |
| /index.html.md | Overview page Markdown |
| /es/llms.txt | Spanish index |
| /es/llms-full.txt | Full Spanish guide as one Markdown file |
| /es/{slug}.md | Spanish single-page Markdown |
| /openapi.json | Machine-readable OpenAPI 3 contract (powers Scalar) |
| /api-reference | Interactive Scalar UI for every documented operation |
Deployed contract
Open the live API explorer
The interactive explorer and machine-readable schema are served directly by this portal.
GET /openapi.json