Pular para o conteúdo principal

Aprovar um Lote de Transferência

PUT 
/v2/transfer/batches/:uid/approve

Processamento Assíncrono: Este endpoint é processado assincronamente e cria um comando de aprovação para o Lote de Transferência. A resposta traz em data o comando de aprovação do lote. Esse comando é a autorização do lote: cada transferência apta (aguardando aprovação e com registro confirmado) é liberada separadamente na instituição financeira sob essa autorização, inclusive as que ficarem aptas depois desta chamada. 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 libera apenas as transferências que ficaram aptas desde a chamada anterior. Um data.uid diferente só aparece quando a autorização anterior deixou de valer:

  • o lote foi reprovado antes da primeira liberação (o comando anterior fica interrupted);
  • a instituição financeira recusou a liberação de todas as transferências (o comando anterior fica failed).

A resposta 422 com Nenhuma transferência do lote está apta a ser aprovada. ocorre quando não há autorização em pé e nenhuma transferência do lote pôde ser enviada (nenhuma transferência do lote está apta ou o provedor financeiro não oferece a operação via API).

Aprovação não atômica​

Cada transferência é liberada separadamente. O comando vai a confirmed na primeira liberação; o status do lote só vai a approved quando todas as transferências forem liberadas. Acompanhe cada transferência pelo status dela.

Controle por item​

Para liberar uma transferência por vez, use a aprovação da própria transferência: PUT /api/v2/transfer/ted/{uid}/approve ou PUT /api/v2/transfer/pix/{uid}/approve. Cada chamada cria um comando só para aquela transferência, que precisa estar apta. Uma aprovação do lote feita depois não duplica a liberação: transferências com aprovação já em andamento são ignoradas. Transferências internas não têm liberação por item via API.

Eventos de Webhook​

  • transfer.transfer_batch.approve.requested: quando a requisição é realizada.
  • transfer.transfer_batch.approve.confirmed: na primeira liberação, com as demais transferências ainda em processamento.
  • transfer.transfer_batch.approve.failed: quando a instituição financeira recusa a liberação de todas as transferências.

Request​

Responses​

Comando de aprovação do lote