Notificación del estado de una orden
Es posible notificar el estado de una orden a la URL especificada en el campo notification_url
al momento de crearla.
La comunicación de las notificaciones vía Webhook constará de un HTTP POST
request.
Al indicarse una URL en el campo notification_url
en la creación de una orden, cuando ocurra un evento, se notificará vía HTTP POST.
Para indicar que la notificación fue correctamente recibida, hay que responder con un status code 200
. Si se responde con un status code diferente, se reprocesará y se notificará hasta 3 veces más.
¡Aviso importante! Para usar este Webhook, es necesario disponibilizar un
endpoint público que acepte una comunicación de tipo POST
.
Si la notificación de una orden falle por completo (4 intentos en total: primer intento más los 3 intentos adicionales), se disponibiliza un endpoint para consultar las notificaciones fallidas.
Posibles estados de la orden que se notifica vía webhook:
Estado | Descripción |
---|---|
APPROVED | El pago fue exitoso y se desembolsó el dinero a la persona en su cuenta de Ualá. |
PROCESSED | La orden fue procesada exitosamente y está pendiente su desembolso. |
REJECTED | El pago de la orden fue rechazado por algún motivo. |
Ejemplo de una notificación:
{
"uuid": "9d42ef50-a139-4606-bc21-43d5e2722876",
"external_reference": "sf2e0241-a139-4606-adb1-74a842641281",
"status": "APPROVED",
"created_date": "2022-06-06T13:23:27Z",
"api_version": "2"
}
Campo | Tipo | Descripción |
---|---|---|
uuid | string | Identificador único de la orden. |
external_reference | string | Número de referencia de la orden. Este puede ser dado por la tienda al momento de crear la orden. |
status | string | Estado de la orden. |
created_date | string | Fecha de creación de la orden. |
api_version | string | Versión de la API de Ualá Bis API Cobros Online. |