Saltar al contenido

Consultar estado de la recarga

Descripción

Este método permite consultar el estado de una recarga para confirmar el resultado final de la transacción, usando el folio devuelto al generar la recarga.


URL API

BASE URLhttps://apidevstore.axiosmobile.mx/v2

Autenticación

Este endpoint se autentica mediante API Key.

MecanismoHeaderDescripción
API Keyx-api-key: {{apiKey}}Clave de API asignada a tu cuenta

Envía la clave en el header x-api-key en cada solicitud. No hay flujo de login previo. Solicita tu clave contactando al equipo de soporte Axios.

SituaciónCódigo
Header x-api-key ausente401
Clave inválida o no habilitada403

Parámetros de Entrada

Al ser un método GET, no es necesario enviar contenido en el body, solo se debe incluir el folio en la URL.

ParámetroTipoUbicaciónRequeridoDescripción
foliostringPath paramSíIdentificador de la transacción a consultar.

Ejemplo de Uso

Endpoint:

GETapidevstore.axiosmobile.mx/v2/transactions/check/:folio
GET /v2/transactions/check/1000365e55a3ca5ed53001a7a9479 HTTP/1.1
Host: apidevstore.axiosmobile.mx
x-api-key: {{apiKey}}

Body: No aplica


Respuestas

200 — Transacción completada Success

La transacción alcanzó un estado final exitoso. El details contiene la respuesta de la plataforma.

{
"message": "Transacción completada",
"folio": "1000365e55a3ca5ed53001a7a9479",
"details": {
"Confirmation": "00",
"Description": "TRANSACCIÓN EXITOSA",
"Folio": "2940590",
"Balance": "0",
"Notice": "Buenos dias",
"transaction_date": "03/03/2024 22:51:57"
}
}

200 — Transacción en proceso Pendiente

La transacción no alcanzó un estado final. El details contiene la última respuesta recibida de la plataforma.

{
"message": "Transacción en proceso",
"folio": "1000365e55a3ca5ed53001a7a9479",
"details": {
"Confirmation": "24",
"Description": "RECARGA EN ESPERA"
}
}

400 — Folio requerido Client Error

Se retorna cuando no se envía el folio en la URL.

{ "message": "El folio es un campo obligatorio para la revisión del estado de la transacción" }

400 — Transacción fallida Client Error

La verificación devolvió un código terminal no exitoso. El details contiene la respuesta de la plataforma.

{
"message": "Transacción fallida",
"folio": "1000365e55a3ca5ed53001a7a9479",
"details": {
"Confirmation": "17",
"Description": "TRANSACCIÓN NO CONFIRMADA"
}
}

404 — Transacción no encontrada Client Error

No existe una transacción asociada al folio enviado.

{
"message": "Transacción no encontrada",
"folio": "1000365e55a3ca5ed53001a7a9479"
}

500 — Error al revisar el estado Server Error

Ocurrió un error inesperado al consultar el estado de la transacción.

{
"message": "Error al revisar el estado de la transacción",
"folio": "1000365e55a3ca5ed53001a7a9479",
"details": "[mensaje del error]"
}

429 — Demasiadas peticiones Client Error

Se retorna cuando se supera el límite de peticiones.

{ "error": "Too many requests, please try again later" }

Parámetros de Salida

ParámetroTipoDescripciónEjemplo
messagestringDescripción del resultado de la operación."Transacción completada"
foliostringIdentificador único de la transacción en Axios."1000365e55a3ca5ed53001a7a9479"
detailsobjectDetalle de la confirmación devuelto por la plataforma.—
details.ConfirmationstringCódigo de respuesta de la plataforma."00"
details.DescriptionstringDescripción de la transacción."TRANSACCIÓN EXITOSA"
details.FoliostringFolio de la operadora."2940590"
details.BalancestringSaldo actual del cliente."0"
details.NoticestringAviso informativo."Buenos dias"
details.transaction_datestringFecha y hora de la plataforma."03/03/2024 22:51:57"

Probar Endpoint

GEThttps://apidevstore.axiosmobile.mx/v2/transactions/check/:folio
Consultar estado de recarga — Requiere API Key en el header x-api-key. Ingresa el folio obtenido al realizar la recarga.
Parámetros de ruta
:folio
Headers