API Reference

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

CampoTipoObligatorioDescripción
x-api-key
StringAPI Key provista para acceder al endpoint.

Query Parameters

CampoTipoObligatorioDescripción
companyCode
StringCódigo único de la compañía a consultar.

Response

Response Body

ParámetroTipoDescripción
companyCode
StringCódigo de la compañía.
companyName
StringNombre de la compañía.
companyType
StringTipo de compañía.
companyLogo
StringLogo de la compañía codificado en base64.
tags
ObjectTags relacionados con la compañía.
products
Object[]Lista de productos disponibles para esta compañía.
identifierName
StringIdentificador a ingresar por el usuario.
identifierValue
StringValor que debe ingresar el usuario.
dataType
StringTipo de dato esperado.
helpText
StringTexto de ayuda para el usuario.
minLength
NumberLongitud mínima del valor.
maxLength
NumberLongitud máxima del valor.
tx
StringIdentificador interno de la transacción.
mainTx
StringIdentificador 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'