Como funciona

Adotamos um modelo de criação de pagamentos por lote, onde você pode nos enviar um ou até no 5.000 pagamentos dentro de um mesmo lote. Dessa forma é possível organizar melhor os seus pagamentos e também otimizar a carga de pagamentos podendo enviar mais de um pagamento usando uma mesma requisição.

Imagem ilustrando o fluxo de criação de lote. Descrição em texto na sequência.

Imagem ilustrando o fluxo de criação de lote. Descrição em texto na sequência.

1 - Crie um lote vazio ou com pagamentos (POST)

Crie um lote em modo rascunho para adicionar diversos pagamentos até que estejam prontos para serem processados ou você pode criar um lote em modo rascunho já com pagamentos dentro dele.

2 - Crie transferências ou boletos nesse lote (POST)

Utilize os endpoints de criação de pagamento de boletos ou de transferências, adicionando um ou vários pagamentos ao lote. Você pode incluir, editar ou excluir pagamentos enquanto o lote estiver no status ”Rascunho”.

3 - Processe os lotes de pagamentos (POST)

Tendo saldo em sua conta, você pode fechar o lote e processar os pagamentos que ele contém. Após este post, o status pode mudar de Rascunho para ”Aguardando recebimento” caso você não tenha saldo suficiente em conta ou ”Recebido”, onde iniciará o processamento dos pagamentos do lote.

4 - Consulte um lote específico (GET)

Você pode a qualquer momento consultar o status do lote, assim como saber mais detalhes, como o tipo de lote ( boletos ou transferências ), a data de recebimento do lote (momento em que é feito a reserva do recurso), a data de finalização, quem criou o lote, etc.