Listar métodos de pago
GET /api/payment-method-types
Autenticación: Bearer del usuario del tenant (Authorization: Bearer <api_token>).
Lista los métodos de pago de la empresa (efectivo, billeteras, transferencias, tarjetas y condiciones de crédito) en el orden configurado, con su regla de destino. Es la vista de administración: incluye los inactivos. Para llenar un formulario de cobro usa Catálogos → Métodos de pago (catalogs/payment-method-types), que solo trae los activos.
Quién puede usarlo: solo usuarios de tipo administrador (type = admin). Con el token de un vendedor responde 403.
Formato de respuesta: listado con paginación por cursor {success, data[], pagination: {next_cursor, has_more}}.
Parámetros de la URL (query):
| Campo | Tipo | Obligatorio | Descripción / valores permitidos |
|---|---|---|---|
is_active |
0 / 1 | No | 1 = solo activos; 0 = solo inactivos. Sin el parámetro, todos. |
for |
string | No | income = los que sirven para cobrar; expense = los que sirven para pagar. |
search |
string | No | Coincidencia parcial en la descripción. |
limit / cursor |
integer / string | No | Paginación por cursor. |
Paginación por cursor: envía limit (1 a 100, por defecto 15). La respuesta trae pagination.next_cursor; para la página siguiente repite la misma consulta agregando cursor=<next_cursor>. Cuando pagination.has_more es false no hay más páginas.
Campos de cada método:
| Campo | Tipo | Descripción |
|---|---|---|
id |
string | Código interno de 2 caracteres. Es el payment_method_type_id que se envía al registrar cobros y pagos. |
description |
string | Nombre. |
sort_order |
integer | Posición en las listas (menor = primero). |
is_active |
boolean | Se ofrece en los formularios. |
is_credit / number_days |
boolean / integer | Condición de crédito y su plazo. |
is_payment_medium |
boolean | false en las condiciones de crédito. |
goes_to_cash_drawer |
boolean | Entra al cajón (efectivo). |
use_for_income / use_for_expense |
boolean | Para cobrar / para pagar. |
destination_rule |
string | Regla de destino (any, type:<tipo>, account:<id>). |
default_destination_id |
integer o null | Cuenta fija (regla account:<id>). |
allowed_destination_type |
string o null | Tipo de cuenta permitido (regla type:<tipo>). |
destination_label |
string | Texto del destino para mostrar (Caja, Cualquier banco, nombre de la cuenta, Se elige al registrar). |
uses_label |
string | Cobros y pagos, Solo cobros, Solo pagos, Sin uso o Condición de pago. |
has_no_use |
boolean | Medio de pago sin ningún uso (queda inactivo). |
can_delete |
boolean | false en los códigos del sistema 01 a 10. |
logo_url / initials / monogram_color |
string | Logotipo subido (o null) y monograma para mostrar cuando no hay logo. |
Las condiciones reservadas del sistema (Crédito, Contado) no se listan.
Errores:
403si el usuario no es administrador.422siforois_activetienen un valor no permitido.401sin token o con un token inválido.
Parámetros
| Parámetro | Dónde | Obligatorio | Ejemplo | Descripción |
|---|---|---|---|---|
is_active |
query | no | 1 |
1 activos, 0 inactivos. |
for |
query | no | income |
income o expense. |
search |
query | no | Busca en la descripción. | |
limit |
query | no | 15 |
Registros por página, de 1 a 100. Por defecto 15. |
cursor |
query | no | Valor de pagination.next_cursor de la respuesta anterior para obtener la página siguiente. |
Respuestas
200 — Listado
{
"success": true,
"data": [
{
"id": "01",
"description": "Efectivo",
"sort_order": 10,
"is_active": true,
"is_credit": false,
"number_days": 0,
"has_card": false,
"charge": 0.0,
"is_payment_medium": true,
"goes_to_cash_drawer": true,
"use_for_income": true,
"use_for_expense": true,
"destination_rule": "any",
"default_destination_id": null,
"allowed_destination_type": null,
"destination_label": "Caja",
"uses_label": "Cobros y pagos",
"has_no_use": false,
"can_delete": false,
"logo_url": null,
"initials": "EF",
"monogram_color": "#0f766e"
},
{
"id": "04",
"description": "Transferencia",
"sort_order": 20,
"is_active": true,
"is_credit": false,
"number_days": 0,
"has_card": false,
"charge": 0.0,
"is_payment_medium": true,
"goes_to_cash_drawer": false,
"use_for_income": true,
"use_for_expense": true,
"destination_rule": "type:bank",
"default_destination_id": null,
"allowed_destination_type": "bank",
"destination_label": "Cualquier banco",
"uses_label": "Cobros y pagos",
"has_no_use": false,
"can_delete": false,
"logo_url": null,
"initials": "TR",
"monogram_color": "#1a4f7a"
},
{
"id": "13",
"description": "Yape",
"sort_order": 30,
"is_active": true,
"is_credit": false,
"number_days": 0,
"has_card": false,
"charge": 0.0,
"is_payment_medium": true,
"goes_to_cash_drawer": false,
"use_for_income": true,
"use_for_expense": true,
"destination_rule": "account:4",
"default_destination_id": 4,
"allowed_destination_type": null,
"destination_label": "YAPE TIENDA CENTRO",
"uses_label": "Cobros y pagos",
"has_no_use": false,
"can_delete": true,
"logo_url": "https://empresa.dominio/logo/payment-methods/yape-13.png",
"initials": "YA",
"monogram_color": "#6b3fa0"
}
],
"pagination": {
"next_cursor": "eyJpZCI6MTUsIl9wb2ludHNUb05leHRJdGVtcyI6dHJ1ZX0",
"has_more": true
}
}
403 — Usuario no administrador
{
"success": false,
"message": "Solo un administrador puede gestionar este recurso."
}
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.