Processar um lote
Dispara todos os pagamentos do lote. A operação não pode ser desfeita. A resposta traz o lote com o novo status (processing).
Se o lote exige aprovação e ela ainda não ocorreu, retorna 403. Um lote já concluído retorna 409.
Envie X-Idempotency-Key: repetir a chamada com a mesma chave devolve o resultado da primeira execução, sem disparar os pagamentos novamente.
Request Specifications
Request
Responses
- 200
- 400
- 403
- 404
- 409
Lote em processamento
400 — a requisição não pôde ser interpretada. Duas causas: missing-idempotency-key, quando um POST ou PATCH não traz X-Idempotency-Key; e invalid-body, quando o corpo não segue o schema da operação (campo obrigatório ausente ou tipo errado). O campo invalidParams indica o que corrigir.
403 — a chamada não traz a autorização necessária no token. O gateway recusa antes de chegar à API. Exemplo: Pix com vencimento recorrente (Pix Automático) exige o consentimento do pagador.
Recurso não encontrado
409 — o pedido é válido, mas o estado atual do recurso não permite a operação. Exemplos: cancelar um pagamento já liquidado, abandonar um lote em processamento, parar uma recorrência encerrada. Difere do 422 (a combinação de campos enviada é inválida) e do 409 de pré-condição de meio de pagamento.