Destinos de pago (caja y cuentas)
GET /api/catalogs/payment-destinations
Autenticación: Bearer del usuario del tenant (Authorization: Bearer <api_token>).
Valores válidos de payment_destination_id (y pagos[].codigo_destino_pago): a dónde entra o de dónde sale el dinero de un pago. Incluye las cuentas bancarias, billeteras y pasarelas del establecimiento del usuario (y las generales) y, solo si el usuario tiene una caja abierta, la caja con id = "cash".
Quién puede usarlo: cualquier usuario autenticado (administrador o vendedor).
Formato de respuesta: estándar {success, data, message?} (registro único). Aquí data es la lista completa (sin paginación ni pagination): son catálogos cortos.
Activos: devuelve los destinos que el usuario puede usar ahora mismo (all no aplica).
Parámetros de la URL (query):
| Campo | Tipo | Obligatorio | Descripción / valores permitidos |
|---|---|---|---|
for |
string | No | income = solo cuentas que reciben cobros; expense = solo cuentas que permiten pagar. La caja siempre se incluye. |
currency_type_id |
string | No | PEN o USD: solo cuentas en esa moneda (la caja acepta ambas). |
Campos de cada fila de data:
| Campo | Tipo | Obligatorio | Descripción / valores permitidos |
|---|---|---|---|
id |
integer / string | Sí | Id de la cuenta, o cash para la caja abierta del usuario. |
cash_id |
integer/null | Sí | Id de la caja abierta (solo en la fila cash). |
description |
string | Sí | Descripción para mostrar al usuario. |
type |
string | Sí | cash (caja), bank (cuenta bancaria), wallet (billetera digital), gateway (pasarela de pago) o card (tarjeta de la empresa). |
type_label |
string | Sí | Nombre del tipo para mostrar. |
currency_type_id |
string | No | Moneda de la cuenta: la cuenta solo recibe pagos en su moneda. (No viene en la fila cash.) |
receives_income |
boolean | No | La cuenta puede recibir cobros. (No viene en la fila cash.) |
allows_payments |
boolean | No | La cuenta puede usarse para pagar. (No viene en la fila cash.) |
establishment_id |
integer/null | No | Establecimiento de la cuenta; null = general. |
reconciles_with |
string | No | Contra qué se cuadra la cuenta (texto informativo). |
logo_url |
string/null | No | Logo de la cuenta o billetera, si tiene. |
Reglas:
- Para cobrar o pagar en efectivo con
cashel usuario del token debe tener una caja abierta; si no aparececashen esta lista, abre una caja antes. - Respeta
allowed_destination_typeygoes_to_cash_drawerdel método de pago (ver Métodos de pago). - Una pasarela (
gateway) solo cobra; la tarjeta de la empresa (card) solo paga.
Errores:
401sin token o con un token inválido.
Parámetros
| Parámetro | Dónde | Obligatorio | Ejemplo | Descripción |
|---|---|---|---|---|
for |
query | no | income |
income o expense. Opcional. |
currency_type_id |
query | no | PEN |
PEN o USD. Opcional. |
Respuestas
200 — Catálogo
{
"success": true,
"data": [
{
"id": 3,
"cash_id": null,
"type": "wallet",
"type_label": "Billetera digital",
"reconciles_with": "Con la aplicación de la billetera",
"logo_url": null,
"receives_income": true,
"allows_payments": true,
"currency_type_id": "PEN",
"establishment_id": null,
"description": "PEN - YAPE EMPRESA"
},
{
"id": 5,
"cash_id": null,
"type": "bank",
"type_label": "Cuenta bancaria",
"reconciles_with": "Con el estado de cuenta del banco",
"logo_url": null,
"receives_income": true,
"allows_payments": true,
"currency_type_id": "PEN",
"establishment_id": 1,
"description": "BANCO DE CREDITO DEL PERU - PEN - CTA CTE 191-2345678-0-11"
},
{
"id": "cash",
"cash_id": 4,
"description": "CAJA GENERAL - CAJA-0004",
"type": "cash",
"type_label": "Caja"
}
]
}
Pruébalo
Prueba este endpoint con tu empresa y tu token: elige la URL en Servers, pega el token en Authorize y haz clic en Try it out.