Consulta transacción
Descripción | Consultar el estado de una transacción |
---|---|
Tipo | POST |
URL | http://widget.movired.cl/api/widget/verify-payment |
Parámetros del encabezado
Nombre | Valor | Descripción |
---|---|---|
content-type | application/json | Indica que el cuerpo o la respuesta está en json |
x-widget-token | string | Token recibido en el webhook, o el creado a través de la api “create private token” en la modalidad Widget Pasarela |
Respuestas
Código Http | Cuerpo de la respuesta |
---|---|
200 | Ok |
400 | Token no válido, o problemas en la validación |
Ejemplos de códigos
Solicitud
Código Javascript
fetch("https://widget.movired.cl/api/widget/verify-payment", { method: "POST", headers: { "x-widget-token": tu_private_token, "Content-Type": "application/json", }, }) .then(json => json.json()) .then(data => { console.log(data); }) .catch(e => console.log(e))
En caso que la solicitud este ok(200) la respuesta recibida tiene el siguiente formato
{
"estado": estado,
"respuesta": {
"identificador": identificador,
"monto": monto,
"nro_tarjeta": numero_tarjeta,
"email": email,
"fecha_hora": fecha_hora,
"estado": estado,
"external_id": external_id(opcional)
}
}
Aclaremos las propiedades del objeto:
1. estado
: El campo estado
indica el estado de la transacción, toma valor true cuando la transacción es exitosa y false en caso contrario.
2. respuesta
: El campo respuesta
es un objeto que entrega mas detalles de la transacción.
a. identificador
: El campo identificador
es nuestro id interno que identifica la transacción.
b. monto
: El campo monto
indica el monto pagado por el usuario mediante el widget.
c. nro_tarjeta
: El campo nro_tarjeta
indica el número de la cuenta a la que se realiza el pago/carga.
d. email
: El campo email
indica el correo electrónico del usuario indicado en el widget.
e. fecha_hora
: El campo fecha_hora
, con formato (yyyy-mm-dd hh:mm:ss), indica la fecha en que recibimos la notificación de la transacción.
f. estado
: El campo estado
indica el estado de la transacción, puede tomar valores del 1 al 4, donde estos son:
- created
- failed
- rejected
- succeeded
g. external_id
: El campo opcional external_id
, indica el id externo recibido por el endpoint “crear private token” en la modalidad de “widget Pasarela”.
Cuando la solicitud ha fallado se indica con el http code 400, y en el cuerpo de la respuesta el objeto solo trae la propiedad error
que da la descripción de lo sucedido.