Pular para o conteúdo principal

Criar Lote de Pagamentos de Tributo

POST 
/v2/payment/tax_batches

Esse endpoint é utilizado para a geração de um lote de pagamento de tributos municipais, estaduais e federais.

⚠️ Novidade em Desenvolvimento! Esta API está em versão beta - isso significa que estamos constantemente melhorando e ajustando suas funcionalidades. Embora seja totalmente funcional, algumas coisas podem mudar conforme recebemos feedback dos desenvolvedores.

Para dúvidas sobre esta funcionalidade, entre em contato conosco.

Pré-requisito​

Para emitir um lote de pagamento é necessário ter uma Conta Financeira, informada em financial_account_uid. A conta de pagamento aplicada ao lote é definida em payment_account_uid; se omitida, usa-se a mais antiga vinculada à conta financeira; se informada, deve pertencer à financial_account_uid.

Eventos de Webhook​

O evento payment.batch.db.created é disparado nesta operação.

Ao cadastrar um Lote de Pagamento, o sistema cria um comando para registrá-lo na instituição financeira. Após o registro do lote ser confirmado na instituição, o evento payment.tax_batch.confirmed é disparado.

O evento payment.db.created também é disparado nesta operação caso o lote contenha um novo pagamento.

Request​

Responses​

Lote criado com format=data (GRU)