Company Code
GET
/{companyCode}
Obtiene el detalle completo de una compañía específica.
Objetivo
Permite recuperar todos los datos relacionados a una empresa en particular para poder realizar la recarga.
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 |
---|---|---|---|
companyCode | String | Sí | Código único de la compañía a consultar. |
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 de la compañía codificado en base64. |
tags | Object | Tags relacionados con la compañía. |
products | Object[] | Lista de productos disponibles para esta compañía. |
identifierName | String | Identificador a ingresar por el usuario. |
identifierValue | String | Valor que debe ingresar el usuario. |
dataType | String | Tipo de dato esperado. |
helpText | String | Texto de ayuda para el usuario. |
minLength | Number | Longitud mínima del valor. |
maxLength | Number | Longitud máxima del valor. |
tx | String | Identificador interno de la transacción. |
mainTx | String | Identificador principal de la transacción. |
Response Examples
200 OK
Consideraciones
- Este endpoint responde con el detalle de una sola compañía.
- Si el companyCode es inválido o la empresa está inactiva, se devuelve un error.
CLIENT LIBRARIES
REQUEST EXAMPLE
curl --request GET \ --url https://companies.homo.tapila.cloud/recharges/AR-R-0001 \ --header 'x-authorization-token: YOUR_TOKEN_HERE' \ --header 'x-api-key: YOUR_API_KEY_HERE'