Skip to main content
Este documento descreve os payloads de webhook relacionados a transações de pontos.

Transações de Pontos

Alterações no registro de pontos.
{
  "Points": 150,
  "PointType": 0,
  "PointAction": 1,
  "Customer": { ... },
  "PointsBalance": {
    "PointsBalance": 1650,
    "CashbackBalance": 16.50
  },
  "Cashback": 1.50,
  "ValidDate": "2025-05-20T00:00:00Z",
  "ValidDateFormatted": "20/05/2025",
  "PointId": 98765,
  "EventDate": "2025-04-15T10:05:10Z",
  "Origins": [
    {
      "PointId": 12345,
      "UsedPoints": 100,
      "UsedCashback": 1.00
    }
  ]
}
Points
number
required
Pontos da transação
PointType
number
required
Tipo/razão. Veja PointType
PointAction
number
required
Ação. Veja PointAction
Customer
object
required
PointsBalance
object
required
Cashback
number
Equivalente em cashback deste registro de pontos. Pode ser negativo quando a transação remover pontos.
ValidDate
string
Data/hora de validade (ISO 8601) para registros com pontos positivos. Pode ser null.
ValidDateFormatted
string
Data de validade formatada em dd/MM/yyyy. Vem vazia quando ValidDate for null.
PointId
number
required
ID interno da transação
EventDate
string
required
Data/hora do evento (ISO 8601)
Origins
array
required
Lista de pontos de origem utilizados na transação. Cada item contém:
  • PointId: ID do ponto de origem
  • UsedPoints: Pontos utilizados deste registro
  • UsedCashback: Cashback utilizado deste registro

Tópicos Disponíveis

TópicoDescrição
Point_AddPonto adicionado
Point_UpdatePonto atualizado
Point_RemovedPonto removido

Documentação atualizada em Dezembro de 2025.