API disponível somente em ambiente de produção
Requisitos para utilização da API
- Em algum momento, é necessário ter o serviço de cashback ativado no seu painel do Dom, mesmo que ele não esteja ativo para suas transações.
- Enviar somente dados de consumidores pessoa física
- Estar de acordo com as políticas da CRM Bônus.
Tabela de Status
| Status | Descrição |
|---|---|
| delivered | Confirmação que o cashback foi entregue com sucesso para o Vale Bônus |
| error | Erro ao processar a requisição. |
| pending | A solicitação ficou pendente de processamento junto a Vale Bônus, no momento que for processada, o status será enviado para a postbackUrl se informada na requisição. |
| bad_request | Algum dado do consumidor é inválido. |
Payload do webhook enviado a postbackUrl
{
"data": {
"name": "João da Silva",
"document": "05111111111",
"mobile_phone": "483999999",
"date": "2025-05-03 11:25:21",
"attempts": 1,
"status": "bad_request",
"error": "Invalid cellphone number",
"total": 30.5,
"cod_external": "",
"postbackUrl": "",
"idempotency_key": "",
}
}