Skip to content

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ámetroTipoObligatorioDescripción y reglas
search_textstringNoFiltro. 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" }
  ]
}
ClaveDescripción
successtrue si se encontró al menos un banco.
banks[]Lista de bancos.
banks[].id_bankIdentificador interno del banco (se devuelve como texto).
banks[].bank_codeCódigo bancario de 4 dígitos (por ejemplo 0134).
banks[].bank_nameNombre del banco (hasta 50 caracteres).

Los datos mostrados son ilustrativos; consulta siempre el endpoint para obtener la lista vigente.

Errores ​

HTTPMensaje (ejemplo)Causa
404No se encontraron bancos registrados.Ningún banco coincide con search_text.
400El 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 / 401Ver ErroresToken ausente, con formato inválido, expirado o no autorizado.
500Ocurrió un error al procesar la solicitud.Error interno.

Notas ​

  • En los errores de autenticación la respuesta trae success y también la clave antigua status con el mismo valor: {"message": "...", "status": false, "success": false}.

API de Facturación · CG Imprenta Digital