Jornada do produto

Esta API funciona como um gateway de pagamento, porém com um viés de análise de crédito. Todo nosso fluxo pode ser exemplificado em uma jornada de compra B2B:

Jornada do produto

  1. Setup Projeto
  2. Cadastro de Cliente
  3. Pedido Realizado
  4. Pedido Realizado com Repasse dos custos para o cliente
  5. Pedido Faturado
  6. Emissão do Boleto
  7. Antecipação e Conciliação
  8. Recompra - problemas na operação do cliente CashU

Setup Projeto

Para iniciar a integração com nosso sistema, solicitamos o envio do histórico de pagamentos dos últimos dois anos. Este processo garante que o time escolha a melhor modelagem de crédito para seus clientes. Após a conclusão bem-sucedida do envio, nossa equipe realizará as configurações necessárias para o seu ambiente. Para isso, você pode criar um script que cadastra os clientes enviando tudo em POST /api/v2/customers e, um outro script para os pedidos em POST /api/v2/orders uma única vez. Importante ressaltar que esses pedidos históricos podem serem enviados sem o XML, facilitante o envio em lote.

Ao finalizar o envio, nosso time irá as configurações de seu projeto. Uma vez finalizado, iremos retornar os limites iniciais de seus clientes recorrentes no Webhook do Cliente.

Detalhes importantes

Para que a CashU valide os pedidos na receita, precisamos que um dos caminhos abaixo seja realizado:

  1. Cadastrar os CNPJs emissores(cedentes) e seus certificados neste link
  2. Ou colocar o CNPJ da CashU em cópia como responsável técnico em toda nota emitida

Cadastro de Cliente

Ao cadastrar um novo cliente na plataforma, você deve enviar para CashU, através da rota POST api/v2/customers. Além de enviar os dados básicos, você deve coletar o termo de uso para coleta de Opt-in. Após o recebimento do cadastro do cliente, o sistema irá retornar no Webhook do Cliente, o crédito disponível para o novo cliente.

Pedido Realizado

Assim que o cliente fizer um pedido na plataforma, você deve enviar os dados do pedido na rota POST /api/v2/orders com o status processing. Após o recebimento, nosso sistema irá analisar e retornar se o pedido foi aprovado ou não para antecipação no Webhook de pedido.

Pedido Realizado com Repasse dos custos para o cliente

Caso você vá repassar os custos da operação para o seu cliente, é necessário, antes de faturar o pedido, já ter o valor dos custos calculado, para poder incluí-lo no pedido e na Nota Fiscal. Para isso, você pode utilizar um status especial na criação do pedido: processing_gross_up. Você deve criar o pedido normalmente em nosso sistema, enviando um POST para /api/v2/orders, mas com o status definido como processing_gross_up. Como de praxe, nosso sistema fará a análise do pedido e, ao retornar o webhook de aprovação, cada parcela já virá com o valor atualizado corretamente. Dessa forma, você poderá confeccionar a Nota Fiscal com os valores certos e prosseguir com o faturamento do pedido.

Pedido Faturado

Assim que o pedido é faturado, você deve atualizar o pedido através da rota POST /api/v2/orders enviado o status invoiced e as informações de nota fiscal na própria requisição de pedido(nfe_attributes). Nosso sistema analisará novamente o pedido batendo a informação na receita com o que foi enviado na API, retornando a análise no Webhook de pedido.

Observações sobre pedidos - processando e faturados:

  1. Ao enviar pedido processing o boleto será emitido emitido, apenas quando as informações da nota fiscal forem enviadas e o status do pedido for invoiced.

  2. Caso o pedido seja aprovado significa que iremos antecipar o valor, e caso seja negado, o parceiro pode seguir com a venda, se responsabilizando pelo faturamento.

  3. Caso o pedido seja pago parcialmente, você pode informar ao enviar as parcelas através do campo amount_paid

Todo pedido com qualquer prazo e forma de pagamento, deve ser enviado para a CashU. Porém apenas pedidos a prazo e com forma de pagamento boleto serão analisados, ou seja, não enviaremos retorno de análise para compras a vista, cartão de crédito ou pix.

Emissão do Boleto

A Emissão é realizada pela CashU e acontece após aprovação de antecipação do pedido FATURADO, sendo que emitiremos o boleto com o beneficiário o FIDC da CashU e, para receber cópia do boleto, o parceiro deve estar integrado no Webhook de boleto.

Nos casos onde a antecipação não é aprovada, a emissão de boleto é de sua responsabilidade.

Antecipação e Conciliação

Uma vez que o título foi antecipado, iremos retornar os títulos antecipados e suas condições no Webhook de antecipação uma vez ao dia ao final do horário comercial.

Recompra

Caso ocorra algum problema em algum título que foi antecipado(devolução, cancelamento ou devolução parcial) e os valores e/ou prazo do pedido forem alterados, é necessário que o parceiro sempre informe essas alterações na rota PATCH /api/v2/orders, informando corretamente as alterações em cada campo. Caso esses pedidos já tenham sido antecipados, o sistema da CashU irá calcular os custos desta alteração e irá lançar como uma recompra na próxima operação de antecipação, descontando do valor das próximas notas a serem pagas. As condições de recompra são retornados junto a antecipação do dia no Webhook de antecipação na parte de chargebacks.