Cashback | Dom Docs

O Cashback (Vale Bônus) permite oferecer crédito em conta para seus clientes como benefício em compras. O saldo é gerenciado pela plataforma CRM Bônus, integrada à Dom Pagamentos.

[!WARNING] O Cashback está disponível apenas em ambiente de produção. Não é possível testá-lo no Sandbox.

Pré-requisitos

Serviço de cashback ativado no painel Dom (mesmo que inativo para transações)
Aplicável somente a pessoas físicas (CPF)
Conformidade com as políticas do CRM Bônus

Verifique se o serviço está ativado

No painel Dom, acesse Configurações e confirme que o módulo de Cashback está habilitado.

Configure o `postbackUrl`

Informe uma URL pública no payload para receber notificações de status da entrega do cashback.

Aplique o cashback via transação

O cashback é concedido automaticamente em transações elegíveis quando configurado. Você também pode adicionar cashback avulso sem transação.

Monitore o status via webhook

Sua `postbackUrl` receberá o payload com o status da entrega do cashback.

Consultando cashback de um CPF

curl --request GET \
  --url "{apiUrl}/cashback/{cpf}" \
  --header "Authorization: Bearer {token}"

Exemplo de resposta:

json

[
  {
    "name": "João da Silva",
    "document": "00111111111",
    "mobile_phone": "11999990000",
    "date": "2026-03-27 09:00:00",
    "attempts": 1,
    "status": "delivered",
    "error": "",
    "total": 30.50,
    "postbackUrl": "https://sua-app.com/webhooks/cashback"
  }
]

Status possíveis

Status	Descrição
`delivered`	Cashback entregue com sucesso ao cliente
`pending`	Aguardando processamento
`error`	Falha na entrega — verifique o campo `error`
`bad_request`	Dados inválidos na requisição

Cashback avulso

Você também pode conceder cashback sem uma transação de pagamento — útil para ações promocionais:

curl --request POST \
  --url "{apiUrl}/cashback" \
  --header "Authorization: Bearer {token}" \
  --header "Content-Type: application/json" \
  --data '{
    "name": "João da Silva",
    "document": "00111111111",
    "mobile_phone": "11999990000",
    "total": 25.00,
    "postbackUrl": "https://sua-app.com/webhooks/cashback"
  }'

Recebendo notificações via `postbackUrl`

Quando o status do cashback muda, a Dom envia um POST para sua postbackUrl com o seguinte payload: