¿Para qué sirve esta consulta? #
La comunicación principal del estado de una transacción hacia el Ecommerce se realiza mediante el Webhook. Adicionalmente, CrediSmart permite consultar el estado de una orden mediante una API de Consulta (Callback).
Esta consulta es opcional y permite al Ecommerce obtener el estado de una orden creada.
Request #
Método: GET
Endpoint: /v1/callback
Headers
Content-Type: application/json Accept: application/json Authorization: Bearer <accessToken>
Parámetros
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
customer_document | number | Sí | Documento de identidad del cliente. |
external_order_id | number | Sí | Número de orden enviada al crear la solicitud. |
Respuesta
| Campo | Tipo | Descripción |
|---|---|---|
success | boolean | Indica que la petición fue procesada correctamente. Valor fijo: true. |
code | number | Código de estado de la respuesta. Valor fijo: 200. |
data | object | Objeto contenedor que incluye los detalles específicos de la sesión. |
Datos de la respuesta
| Campo | Tipo | Descripción |
|---|---|---|
status | string | Estado específico de la transacción en la pasarela. |
partner_tx_id | string | Identificador único de la orden enviada al crear la solicitud. |
signature | string | Hash de seguridad para validar la integridad del mensaje. |
Respuesta ejemplo
{
"success": true,
"code": 200,
"data": {
"status": "PENDIENTE",
"partner_tx_id": "TEST-000004",
"signature": "9de04bc9d22cd8347503b84b5af8bdeb41985625b5cd93d891e217291a271917"
}
}
Ejemplo de petición
curl --location '<URL POR DEFINIR>/v1/callback?customer_document=123456789&external_order_id=000001' \ --header 'Authorization: Bearer <AccessToken>' \ --header 'Content-Type: application/json' \ --header 'Accept: application/json'