Listar cuentas
GET /api/bank-accounts
Autenticación: Bearer del usuario del tenant (Authorization: Bearer <api_token>).
Lista las cuentas ordenadas por nombre.
Quién puede usarlo: solo usuarios de tipo administrador (type = admin). Con el token de un vendedor responde 403.
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.
Parámetros
| Parámetro | Dónde | Obligatorio | Ejemplo | Descripción |
|---|---|---|---|---|
search |
query | no | Busca por nombre o número. | |
type |
query | no | bank |
Filtra por tipo: bank, wallet, gateway, card. |
status |
query | no | 1 |
Filtra por estado: 1 activas, 0 inactivas. |
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": 3,
"type": "bank",
"bank_id": 2,
"description": "BCP SOLES",
"number": "191-12345678-0-12",
"currency_type_id": "PEN",
"cci": "00219100123456780122",
"status": 1,
"initial_balance": "0.00",
"show_in_documents": true,
"establishment_id": null,
"receives_income": true,
"allows_payments": true,
"bank_description": "BANCO DE CREDITO DEL PERU",
"type_description": "Cuenta bancaria"
}
],
"pagination": {
"next_cursor": null,
"has_more": false
}
}
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.