Solicitar agendamento em lote de boleto bancário com autenticação de dois fatores (2FA)

Este endpoint permite solicitar o agendamento em lote de boletos bancários em uma única requisição, com autenticação de dois fatores quando aplicável.

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/payments_schedule/batch_bank_slip

MÉTODO

POST

Request Path Params

Campo	Tipo	Descrição	Caracteres
`account_key` *	uuid4	Chave única de identificação da conta.	36

Request Body: Agendamento em lote de boletos bancários

{
  "request_control_key": "b6804f32-101e-4702-8fbc-c2dbc4c2caec",
  "bank_slip_payment_schedules": [
    {
      "request_control_key": "c7915a43-212f-5813-9adc-d3ed5d3d3bfd",
      "digitable_line": "00190000090361557400500000024174396700000991000",
      "payment_amount": 1156.8,
      "payment_date": "2026-04-10"
    },
    {
      "request_control_key": "d8a26b54-323a-4924-0aed-e4fe6e4e4c0e",
      "barcode": "00190000090361557400500000024174396700000991000",
      "payment_amount": 200.5,
      "payment_date": "2026-04-15"
    }
  ],
  "tfa_info": {
    "approver_document_number": "98765432100",
    "contact_type": "email"
  }
}

Body Params

Campo	Tipo	Descrição
`request_control_key` *	uuid4	Chave única de identificação da requisição do cliente (lote).
`bank_slip_payment_schedules` *	array	Lista de agendamentos de boleto bancário. Limite de 1000 itens por requisição.
`tfa_info` *	object	Objeto contendo o documento da pessoa aprovadora da conta e a forma de contato.

Cada elemento de bank_slip_payment_schedules deve conter:

Campo	Tipo	Descrição
`request_control_key` *	uuid4	Chave única de identificação da requisição do cliente para aquele item do lote.
`barcode`	string	Código de barras.
`digitable_line`	string	Linha digitável.
`payment_amount` *	number	Valor a ser pago.
`payment_date` *	string	Data do agendamento do item.

Aviso

Para cada item, o payment_amount deve seguir as regras do título retornadas na consulta do boleto bancário. Se o pagamento parcial não for permitido, o valor deve corresponder ao total atualizado do título.

Objeto tfa_info

Campo	Tipo	Descrição
`approver_document_number`*	string	Número de documento da pessoa aprovadora da conta (CPF/CNPJ).
`contact_type`*	enumerator	Forma de envio do token de autenticação

Enumerador	Descrição
sms	Envio por mensagem de texto para telefone celular
email	Envio por correio eletrônico

Response

Success Response

STATUS

202

Response Body: Lote de agendamento pendente de aprovação de dois fatores

{
  "batch_payment_schedule_key": "c4325104-d60b-44f3-aae4-49155564a2ea",
  "request_control_key": "b6804f32-101e-4702-8fbc-c2dbc4c2caec",
  "account_key": "6dc89d57-fac7-4643-b151-cd2ca0a7f68f",
  "total_amount": 1357.3,
  "batch_payment_schedule_status": "pending_2fa_approval",
  "payment_type": "bank_slip"
}

Response Body Params

Campo	Tipo	Descrição
`batch_payment_schedule_key` *	uuid4	Chave única de identificação do agendamento em lote.
`request_control_key` *	uuid4	Chave única de identificação da requisição do cliente (lote).
`account_key` *	uuid4	Chave da conta debitada.
`total_amount` *	number	Soma dos valores (`payment_amount`) dos itens do lote.
`batch_payment_schedule_status` *	enum	Status do lote de agendamento após a solicitação.
`payment_type` *	enum	Tipo do pagamento.

Enumeradores batch_payment_schedule_status

Enumerador	Descrição
`pending_2fa_approval`	Pendente de aprovação 2FA
`scheduled`	Agendado
`rejected`	Rejeitado
`error`	Erro ao agendar

Enumeradores payment_type

Enumerador	Tipo	Descrição
`bank_slip`	string	Boleto bancário
`collection_slip`	string	Fatura de recolhimento

Aviso

O enumerador collection_slip não se aplica ao fluxo de agendamento em lote de boletos bancários deste endpoint; para este caso, espera-se payment_type com valor 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 HTTP	Código QI	Título	Descrição (eng)	Descrição (pt-br)
403	BIP000010	Forbidden	User is not allowed to do this action	Usuário não tem autorização para fazer essa ação
404	BIP000011	Not Found	The source account key was not found.	A chave da conta de origem não foi encontrada.
400	BIP000012	Bad Request	It was not possible to consult the source account at this time. Please try again in a few minutes.	Não foi possível consultar a conta de origem neste momento. Por favor, tente novamente em alguns minutos.
400	BIP000024	Bad Request	Request control key already exists.	Chave de controle da requisição já existe.
400	BIP000052	Bad Request	Given document number does not belong to an approver for this account	Número de documento enviado não pertence a um aprovador da conta
400	BIP000053	Bad Request	Error getting approver data	Erro ao obter dados do aprovador
400	BIP000054	Bad Request	TFA info required	Informações de TFA necessárias
400	BIP000055	Bad Request	Error sending verification token	Erro ao enviar token de verificação
400	BIP000065	Bad Request	Payment verification time window exceeded.	Janela de tempo de verificação de pagamento excedida.

Request​

Request Endpoint​

Request Path Params​

Body Params​

Objeto tfa_info​

Response​

Success Response​

Response Body Params​

Enumeradores batch_payment_schedule_status​

Enumeradores payment_type​

Error Response​