Apariencia
Bancos
GET /api/Invoice/banks
Devuelve el catálogo de bancos venezolanos registrados, con su código de 4 dígitos y su nombre. Úsalo para saber qué valor enviar en el campo banco de los pagos (order_payment_methods[]) 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 banco cuyo bank_code sea exactamente ese valor o cuyo nombre contenga el texto. Si no es numérico, busca bancos cuyo nombre contenga el texto (búsqueda parcial). Si se omite, devuelve todos. |
Ejemplo de solicitud
http
GET {{host}}api/Invoice/banks?search_text=0134
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9...Respuesta exitosa
HTTP 200
json
{
"success": true,
"banks": [
{ "id_bank": "17", "bank_code": "0134", "bank_name": "Banesco" }
]
}Sin filtro devuelve la lista completa, por ejemplo:
json
{
"success": true,
"banks": [
{ "id_bank": "1", "bank_code": "0156", "bank_name": "100% Banco" },
{ "id_bank": "2", "bank_code": "0172", "bank_name": "Bancamiga" },
{ "id_bank": "8", "bank_code": "0102", "bank_name": "Banco de Venezuela" }
]
}| Clave | Descripción |
|---|---|
success | true si se encontró al menos un banco. |
banks[] | Lista de bancos. |
banks[].id_bank | Identificador interno del banco (se devuelve como texto). |
banks[].bank_code | Código bancario de 4 dígitos (por ejemplo 0134). |
banks[].bank_name | Nombre del banco (hasta 50 caracteres). |
Los datos mostrados son ilustrativos; consulta siempre el endpoint para obtener la lista vigente.
Errores
| HTTP | Mensaje (ejemplo) | Causa |
|---|---|---|
| 404 | No se encontraron bancos registrados. | Ningún banco coincide con search_text. |
| 400 | El parámetro de búsqueda debe ser una cadena de texto válida. | search_text no llegó como texto (por ejemplo, enviado como arreglo search_text[]=...). |
| 400 / 401 | Ver Errores | Token ausente, con formato inválido, expirado o no autorizado. |
| 500 | Ocurrió un error al procesar la solicitud. | Error interno. |
Notas
- En los errores de autenticación la respuesta trae
successy también la clave antiguastatuscon el mismo valor:{"message": "...", "status": false, "success": false}.
