Skip to main content
POST
Creditar pontos

Creditar Pontos

Adiciona pontos ao saldo de um cliente. Útil para integração com sistemas de vendas (ERP/PDV) que creditam pontos automaticamente após uma compra.

Comportamento atual

  • a rota aceita X-Idempotency-Key para retry seguro
  • o crédito é aplicado de forma atômica no saldo da carteira
  • a resposta retorna o saldo final, não o histórico completo da transação

Body Parameters

string
required
ID do cliente que receberá os pontos (UUID)
integer
required
Quantidade de pontos a creditar. Deve ser maior que 0.
string
Motivo do crédito (ex: “Compra #12345”, “Bonificação mensal”)

Request

Response

Campos da Resposta

string
ID do cliente que recebeu os pontos
integer
Novo saldo de pontos do cliente após o crédito
string
Empresa dona da carteira creditada

Headers

X-Idempotency-Key
string | null
X-API-Key
string
required

Chave de API

Body

application/json

Creditar pontos para cliente.

amount
integer
required

Quantidade de pontos a creditar

client_id
string
required

ID do cliente

reason
string | null
default:Crédito via API Pública
Maximum string length: 255

Response

Successful Response

Saldo de pontos de um cliente.

balance
integer
required
client_id
string
required
empresa_id
string
required