Aplicar Descuento | ClubBi
Aplica un descuento a una orden por medio de una tarjeta Club Bi, proporcionando un objeto de tipo Discount Request.
Autenticación
Para poder autenticarse con el API de Club Bi debes de proveer el token obtenido en la llamada de setup.
Payload
A continuación, puedes encontrar un ejemplo del cuerpo de esta llamada. Debajo podrás encontrar una tabla describiendo cada parámetro del cuerpo de la llamada.
Copiado!
{
"discount": 25.00,
"total": 100.00,
"currency": "GTQ",
"code": 1255,
"card": "0508532188771231"
}
discount (Decimal)
Requerido Representa el monto a descontar dentro de la orden.
total (Decimal)
Requerido Representa el monto total de la transacción.
currency (String)
String que representa la moneda en la cual se realizará el cobro, los valores aceptados son GTQ. Cuando este valor no es proporcionado, por defecto siempre sera GTQ.
code (Int)
Requerido Debe contener el código del beneficio brindado por el equipo de integraciónes de Club Bi.
card (String)
Requerido Representa la tarjeta Club Bi del usuario que está solicitando el descuento.
cUrl
Aquí hay un ejemplo de la llamada al API en cUrl.
Recuerda que debes agregar en el header el parámetro de X-TOKEN con el token que retorna la llamada de setup.
Copied!
curl -X 'POST' \
'https://aurora.codingtipi.com/api/benefits/v2/club-bi/discounts' \
-H 'accept: application/json' \
-H 'X-Token: add85aae-069a-404c-b0f2-bf006a323355' \
-H 'Content-Type: application/json'' \
-d '{
"discount": 25.00
"total": 100.00,
"currency": "GTQ",
"code": 1255,
"card": "0508532188771231"
}'
Respuesta
Aquí puedes encontrar el objeto que retorna la llamada con status Created 201. El objeto que retornó, contiene los parámetros que necesitas para validar correctamente el descuento authorization que representa el código de autorización brindado por el sistema de beneficios de Club Bi, y confirmation que representa el código de confirmación del uso del beneficio.
Copied!
{
"authorization" : "4hK8mALQ88BD32RMenlA",
"confirmation" : "4kVwlKO7gdNHCreeko3E"
}
Códigos de Respuesta
Aqui puedes encontrar todos los posibles códigos de respuesta que el API puede contestar.