Saltar al contenido
Facturador

Métodos de pago

GET /api/catalogs/payment-method-types

Autenticación: Bearer del usuario del tenant (Authorization: Bearer <api_token>).

Métodos de pago de la empresa (efectivo, tarjeta, transferencia, Yape...), los mismos que ofrece el sistema al cobrar o pagar. Es el valor de payment_method_type_id en los pagos.

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: solo devuelve los métodos activos (all no aplica: un método inactivo no se acepta en un pago).

Parámetros de la URL (query):

Campo Tipo Obligatorio Descripción / valores permitidos
for string No income = los que sirven para cobrar; expense = los que sirven para pagar (gastos, compras).

Campos de cada fila de data:

Campo Tipo Obligatorio Descripción / valores permitidos
id string Sí Código a enviar en el campo correspondiente del comprobante / registro.
description string Sí Descripción para mostrar al usuario.
is_cash boolean Sí true = efectivo.
is_credit boolean Sí true = es una condición de crédito (p. ej. Factura a 30 días), no un medio de pago.
has_card boolean Sí true = con tarjeta: envía también card_brand_id (ver Marcas de tarjeta).
number_days integer Sí Días de crédito cuando is_credit es true.
charge number Sí Recargo porcentual configurado para el método (0 si no tiene).
is_payment_medium boolean Sí true = medio de pago real (no una condición de crédito).
use_for_income boolean Sí Se puede usar para cobrar.
use_for_expense boolean Sí Se puede usar para pagar.
goes_to_cash_drawer boolean Sí true = el dinero entra a la caja: usa payment_destination_id = cash.
allowed_destination_type string/null Sí Si no es nulo, el destino debe ser una cuenta de ese tipo: bank, wallet, gateway o card.
default_destination_id integer/null Sí Cuenta sugerida por defecto para este método.

Errores:

  • 401 sin token o con un token inválido.

Parámetros

Parámetro Dónde Obligatorio Ejemplo Descripción
for query no income income (cobrar) o expense (pagar). Opcional.

Respuestas

{
  "success": true,
  "data": [
    {
      "id": "01",
      "description": "Efectivo",
      "is_cash": true,
      "is_credit": false,
      "has_card": false,
      "number_days": 0,
      "charge": 0.0,
      "is_payment_medium": true,
      "use_for_income": true,
      "use_for_expense": true,
      "goes_to_cash_drawer": true,
      "allowed_destination_type": null,
      "default_destination_id": null
    },
    {
      "id": "02",
      "description": "Tarjeta de crédito",
      "is_cash": false,
      "is_credit": false,
      "has_card": true,
      "number_days": 0,
      "charge": 0.0,
      "is_payment_medium": true,
      "use_for_income": true,
      "use_for_expense": false,
      "goes_to_cash_drawer": false,
      "allowed_destination_type": "gateway",
      "default_destination_id": null
    },
    {
      "id": "04",
      "description": "Transferencia",
      "is_cash": false,
      "is_credit": false,
      "has_card": false,
      "number_days": 0,
      "charge": 0.0,
      "is_payment_medium": true,
      "use_for_income": true,
      "use_for_expense": true,
      "goes_to_cash_drawer": false,
      "allowed_destination_type": "bank",
      "default_destination_id": null
    },
    {
      "id": "12",
      "description": "Yape",
      "is_cash": false,
      "is_credit": false,
      "has_card": false,
      "number_days": 0,
      "charge": 0.0,
      "is_payment_medium": true,
      "use_for_income": true,
      "use_for_expense": true,
      "goes_to_cash_drawer": false,
      "allowed_destination_type": "wallet",
      "default_destination_id": 3
    },
    {
      "id": "09",
      "description": "Crédito",
      "is_cash": false,
      "is_credit": true,
      "has_card": false,
      "number_days": 30,
      "charge": 0.0,
      "is_payment_medium": false,
      "use_for_income": true,
      "use_for_expense": false,
      "goes_to_cash_drawer": false,
      "allowed_destination_type": null,
      "default_destination_id": null
    }
  ]
}

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.