Apariencia
Métodos de pago
GET /api/Invoice/payments_methods
Devuelve el catálogo de métodos de pago que acepta el API (por ejemplo, transferencia, efectivo, pago móvil, divisa). Úsalo para saber qué valores enviar en order_payment_methods[].order_payment_method al emitir documentos.
Autenticación: Authorization: Bearer <token> (cómo obtenerlo)
Parámetros
Parámetro opcional en la query string (no se envía cuerpo).
| Parámetro | Tipo | Obligatorio | Descripción y reglas |
|---|---|---|---|
search_text | string | No | Filtro. Si es numérico, busca el método con ese id_payment_method o cuyo nombre contenga ese texto. Si no es numérico, busca métodos cuyo nombre contenga el texto (búsqueda parcial). Si se omite, devuelve todos. |
Ejemplo de solicitud
http
GET {{host}}api/Invoice/payments_methods
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9...Con filtro:
http
GET {{host}}api/Invoice/payments_methods?search_text=pago
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9...Respuesta exitosa
HTTP 200
json
{
"success": true,
"payment_methods": [
{ "id_payment_method": "1", "payment_method": "transferencia" },
{ "id_payment_method": "2", "payment_method": "efectivo" },
{ "id_payment_method": "3", "payment_method": "pago movil" },
{ "id_payment_method": "4", "payment_method": "divisa" }
]
}| Clave | Descripción |
|---|---|
success | true si se encontró al menos un método. |
payment_methods[] | Lista de métodos de pago. |
payment_methods[].id_payment_method | Identificador del método (se devuelve como texto). |
payment_methods[].payment_method | Nombre del método, en minúsculas. |
El catálogo mostrado es ilustrativo; consulta siempre el endpoint para obtener los valores vigentes.
Otros métodos de pago
Si order_payment_method trae un nombre que no está en el catálogo (por ejemplo Zelle, Tarjeta débito o Cheque), el pago no se rechaza: se registra como método Otro y se guarda el nombre enviado para mostrarlo en el panel y en el PDF del documento.
El nombre admite un máximo de 20 caracteres y solo letras, números, espacios y
. , & / # + -. Si no cumple, el documento se rechaza con un error que indica el método de pago y el documento, por ejemplo:textEl campo "order_payment_method" en el método de pago 1 de la factura N° 1001 no puede exceder los 20 caracteres ("Tarjeta de debito wally" tiene 23).Se trata como un pago en bolívares: no calcula IGTF. Para pagos en moneda extranjera con IGTF use
divisa.No requiere
banco,numero_de_referencia_de_operacionnitelefono_pago_movil.
json
"order_payment_methods": [
{ "order_payment_method": "Zelle", "monto": "1500.00" }
]Errores
| HTTP | Mensaje (ejemplo) | Causa |
|---|---|---|
| 404 | No se encontraron métodos de pago | Ningún método coincide con search_text. |
| 400 / 401 | Ver Errores | Token ausente, con formato inválido, expirado o no autorizado. |
| 500 | (sin mensaje) | Error interno. La respuesta es solo {"success": false}. |
Notas
- En los errores de autenticación de este endpoint la clave de estado es
status(nosuccess):{"message": "...", "status": false}.
