Fluxo da Integração

Fluxo de integração para emissão de Vale Bonus

Introdução

---

A API do Vale Bonus buscar permitir que um parceiro externo faça uma recarga de vale bonus de maneira simples e automatizada. A principal requisição do fluxo é a /transactions/pre-recharge. Esse endpoint realiza uma recarga automática na carteira do cliente.

O fluxo e frequência de disparo dessa requisição será customizado de acordo com cada caso de uso.

📘

Observações

1. A API aceita apenas uma única recarga por requisição;
2. É possível enviar um webhookExternalId no body da requisição para que o endereço webhook seja notificado sempre que uma recarga é feita;
3. Embora a API receba como chave um valor de "CPF", "CELLPHONE" ou "EMAIL", o parâmetro "cellphone" sempre precisará ser enviado, pois é com base nele que o disparo de mensagem será feito.

Ambientes

---

Autenticação

Ambiente	URL
Homologação	https://apigw-homol.crmbonus.com/modern
Produção	https://apigw.crmbonus.com/modern

Recarga de Vale Bonus

Ambiente	URL
Homologação	https://apigw-homol.crmbonus.com/modern
Produção	https://apigw.crmbonus.com/modern