Skip to main content

Confirmação de lote de pagamento de boleto bancário

Este endpoint permite confirmar ou rejeitar um lote de pagamento de boletos bancários previamente criado com Solicitar pagamento em lote de boleto bancário. A confirmação é a etapa que define se o processamento do lote segue (aprovação) ou é encerrado sem débito dos títulos (rejeição).

Boleto bancário

É o boleto bancário convencional (linhas digitáveis não iniciadas com dígito 8). Possui registro na Câmara Interbancária de Pagamento (CIP/Núclea) e pode ser pago em instituições financeiras e de pagamento autorizadas a funcionar pelo Banco Central.

Request​

Request Endpoint​

ENDPOINT
/bill_payment/account/ACCOUNT_KEY/payment/batch_bank_slip/PAYMENT_BATCH_KEY/confirmation
MÉTODO
PATCH

Request Path Params​

CampoTipoDescriçãoCaracteres
account_key *uuid4Chave única de identificação da conta.36
payment_batch_key *uuid4Chave única de identificação do lote (batch_payment_key retornado na criação do lote).36

Request Body​

Request Body: Rejeição do lote

{
  "batch_status": "rejected"
}

Request Body: Aprovação do lote

{
  "batch_status": "approved"
}

Body Params​

CampoTipoDescrição
batch_status *stringDecisão sobre o lote. Valores: approved (seguir com o processamento) ou rejected (cancelar o lote). Ver enumerador batch_confirmation_status.

Enumerador batch_confirmation_status​

Valores aceitos no corpo da requisição para batch_status:

ValorDescrição
approvedAprovar o lote e continuar o fluxo de processamento.
rejectedRejeitar o lote; não há processamento assíncrono dos boletos.

Response​

Resposta: lote rejeitado​

STATUS
200

Quando batch_status no corpo da requisição é rejected, a API responde com 200. O lote fica encerrado como rejeitado; não há fila assíncrona de pagamento dos boletos.

Response Body: Lote rejeitado

{
  "batch_payment_key": "a3214093-e51c-55e2-b5d3-60244475b3fb",
  "request_control_key": "b6804f32-101e-4702-8fbc-c2dbc4c2caec",
  "account_key": "6dc89d57-fac7-4643-b151-cd2ca0a7f68f",
  "total_amount": 1357.3,
  "batch_status": "rejected",
  "payment_type": "bank_slip"
}

Resposta: lote aprovado — processamento assíncrono​

STATUS
202

Quando batch_status no corpo é approved, a API responde com 202 e o lote segue para processamento assíncrono dos boletos. O corpo retorna batch_status como approved.

Response Body: Lote aprovado para processamento assíncrono

{
  "batch_payment_key": "a3214093-e51c-55e2-b5d3-60244475b3fb",
  "request_control_key": "b6804f32-101e-4702-8fbc-c2dbc4c2caec",
  "account_key": "6dc89d57-fac7-4643-b151-cd2ca0a7f68f",
  "total_amount": 1357.3,
  "batch_status": "approved",
  "payment_type": "bank_slip"
}

Response Body Params​

CampoTipoDescrição
batch_payment_key *uuid4Chave única de identificação do pagamento em lote.
request_control_key *uuid4Chave única de identificação da requisição do cliente (lote).
account_key *uuid4Chave da conta debitada.
total_amount *numberSoma dos valores dos itens do lote.
batch_status *stringStatus do lote após esta chamada (rejected ou approved para o fluxo descrito nesta página). Alinhado ao ciclo de vida em Solicitar pagamento em lote de boleto bancário — batch_payment_status.
payment_type *stringTipo do pagamento; para este fluxo, espera-se bank_slip.

Error Response​

STATUS
4XX

Response Body

{
    "title": "Título",
    "description": "Description in english",
    "translation": "Descrição em português",
    "code": "Código"
}
Código HTTPCódigo QITítuloDescrição (eng)Descrição (pt-br)
400BIP000013Bad RequestThe source account is closed.A conta de origem está fechada.
400BIP000050Bad RequestRequester configuration does not existConfiguração do requester não existe.
404BIP000083Not FoundBatch payment not found by batch payment key.Lote de pagamentos não encontrado pela chave do lote.
400BIP000084Bad RequestBatch payment status is not pending.O status do lote de pagamentos não está pendente.