Como funciona

Utilizando os endpoints da nossa API de transferências, você pode fazer a gestão dos pagamentos criados, em processamento e finalizados, assim como receber alertas via webhooks e acessar os comprovantes de pagamento.

Imagem ilustrando o fluxo de criação de pagamento

Imagem ilustrando o fluxo de criação de pagamento

1 - Crie uma Transferência (POST)

Para criar um pagamento PIX, você deve enviar o valor, o tipo de chave e a chave a ser paga, utilizando o endpoint para criar transferência.

2 - Sua transferência será criado em um lote

A criação do pagamento gera também um lote, onde você pode incluir novas transações ou fechá-lo para ser processado. O lote pode conter um ou vários pagamentos.

3 - Feche para processar o lote de pagamentos (POST)

Assim que o lote for fechado, iniciamos o processamento de todos os pagamentos daquele lote. Você pode monitorar as mudanças de status dos pagamentos ouvindo nossos webhooks através do objeto Transfer.

4 - Acesse o comprovante da transferência

Utilize o endpoint de ”Consultar transferência” para receber o link do comprovante em bank_receipt_url. Para ter um comprovante, o pagamento deve estar no status finalizado!

5 - Monitore o status dos pagamentos

Monitore via webhook para receber as notificações e ter o status dos seus pagamentos atualizados em tempo real.

6 - Atenção para devoluções

Em alguns casos, o recebedor pode devolver o pagamento total ou parcialmente, o pagamento se mantém como finalizado, mas você terá uma entrada de saldo referente à devolução, por isso é importante que seus webhooks de Transfer_refund estejam sempre ouvindo as mudanças de status!

Recibos bancários

Os links dos recibos que estão nos relatórios que geramos, ou que é consultado da nossa API ou e-mail tem uma data de expiração de 60 dias, após isso o link não estará mais disponível por questões de segurança. Para conseguir outro link basta fazer uma nova consulta pela nossa API ou acessar a nossa plataforma.