Pular para o conteúdo principal

Reprovar um Lote de Pagamento

PUT 
/v2/payment/batches/:uid/reprove

Processamento Assíncrono: Este endpoint é processado assincronamente e cria um comando de reprovação para o Lote de Pagamento. A resposta traz em data o comando de reprovação do lote. Esse comando é a autorização da reprovação: cada pagamento apto (aguardando aprovação e com registro confirmado) é rejeitado separadamente na instituição financeira sob essa autorização. A reprovação também interrompe as liberações de pagamentos ainda pendentes. Você pode consultar o comando a qualquer momento pelo data.uid.

Idempotência​

Repetir a chamada enquanto a autorização estiver em pé (comando pending ou confirmed) e o lote ainda estiver aguardando aprovação responde 200 com o mesmo data.uid e rejeita apenas os pagamentos que ficaram aptos desde a chamada anterior. Um data.uid diferente só aparece quando a autorização anterior deixou de valer:

  • o lote foi aprovado antes da primeira rejeição (o comando anterior fica interrupted);
  • a instituição financeira recusou a rejeição de todos os pagamentos (o comando anterior fica failed).

A resposta 422 com Nenhum pagamento do lote está apto a ser rejeitado. ocorre quando não há autorização em pé e nenhum pagamento do lote pôde ser enviado (nenhum pagamento do lote está apto ou o provedor financeiro não oferece a operação via API).

Reprovação não atômica​

Cada pagamento é rejeitado separadamente. O comando vai a confirmed na primeira rejeição; o status do lote só vai a reproved quando todos os pagamentos forem rejeitados. Se a instituição financeira recusar a rejeição de parte dos pagamentos, o lote continua awaiting_approval. Acompanhe cada pagamento pelo status dele.

Eventos de Webhook​

  • payment.payment_batch.reprove.requested: quando a requisição é realizada.
  • payment.payment_batch.reprove.confirmed: na primeira rejeição, com os demais pagamentos ainda em processamento.
  • payment.payment_batch.reprove.failed: quando a instituição financeira recusa a rejeição de todos os pagamentos.

⚠️ Atenção ao status Reprovado: O status de Reprovado é terminal. Quando a instituição financeira cancelar os pagamentos, os mesmos terão seus status alterados para Reprovado.

Request​

Responses​

Comando de reprovação do lote