Recharges Endpoint
GET
/rechargesObtener lista de empresas disponibles para recargas.
Objetivo
Devuelve el listado completo de empresas de recargas activas, con posibilidad de filtrado por estado o nombre.
Request
Headers
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
x-api-key | String | Sí | API Key provista para acceder al endpoint. |
Query Parameters
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
active | Boolean | No | Permite filtrar compañías activas o inactivas. |
searchCompany | String | No | Filtra por nombre de compañía. Requiere al menos 3 caracteres. |
Response
Response Body
| Parámetro | Tipo | Descripción |
|---|---|---|
companyCode | String | Código de la compañía. |
companyName | String | Nombre de la compañía. |
companyType | String | Tipo de compañía. |
companyLogo | String | Logo en base64 o URL pública. |
tags | Object[] | Etiquetas asociadas a la compañía. |
products | Object[] | Productos de recarga disponibles. |
identifierName | String | Nombre del campo a ingresar por el usuario (Ej: número de teléfono). |
identifierValue | String | Valor a ingresar por el usuario. |
dataType | String | Tipo de dato esperado (Ej: ALF, IMP). |
helpText | String | Texto de ayuda para el campo identificador. |
minLength | Number | Cantidad mínima de caracteres aceptados. |
maxLength | Number | Cantidad máxima de caracteres aceptados. |
tx | String | ID de transacción interna de TAPI. |
mainTx | String | ID principal de la transacción interna. |
Response Examples
200 OK
Consideraciones
- Si se desea filtrar solo las compañías inactivas, usar ?active=false.
- El campo searchCompany requiere al menos 3 caracteres para arrojar resultados.
- Este endpoint siempre devuelve compañías activas salvo que se indique lo contrario explícitamente.
CLIENT LIBRARIES
REQUEST EXAMPLE
curl --request GET \ --url https://companies.homo.tapila.cloud/recharges \ --header 'x-authorization-token: YOUR_TOKEN_HERE' \ --header 'x-api-key: YOUR_API_KEY_HERE'