Request batch scheduling of bank slip payments

This endpoint allows you to schedule multiple bank slips in a single request.

Bank slip

This is the conventional bank slip (digitable lines not starting with the digit 8). It is registered with the Interbank Payment Clearinghouse (CIP/Núclea) and can be paid at financial institutions and payment institutions authorized to operate by the Central Bank.

Request

Request Endpoint

ENDPOINT

/bill_payment/account/ACCOUNT_KEY/payments_schedule/batch_bank_slip

METHOD

POST

Request Path Params

Field	Type	Description	Characters
account_key *	uuid4	Unique account identification key.	36

Request Body: Batch scheduling of bank slips

{
  "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"
    }
  ]
}

Body Params

Field	Type	Description
request_control_key *	uuid4	Unique client request key (batch).
bank_slip_payment_schedules *	array	List of bank slip schedules. 1000 items maximum per request.

Each element of bank_slip_payment_schedules must contain:

Field	Type	Description
request_control_key *	uuid4	Unique client request key for that batch item.
barcode	string	Barcode.
digitable_line	string	Digitable line.
payment_amount *	number	Amount to pay.
payment_date *	string	Scheduled payment date for the item.

Warning

For each item, payment_amount must follow the rules for the title returned in the bank slip inquiry. If partial payment is not allowed, the amount must match the updated total of the title.

Response

Success Response

STATUS

202

Response Body: Batch schedule created

{
  "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": "scheduled",
  "payment_type": "bank_slip"
}

Response Body Params

Field	Type	Description
batch_payment_schedule_key *	uuid4	Unique batch schedule key.
request_control_key *	uuid4	Unique client request key (batch).
account_key *	uuid4	Debited account key.
total_amount *	number	Sum of item payment_amount values in the batch.
batch_payment_schedule_status *	enum	Batch schedule status after the request.
payment_type *	enum	Payment type.

Enumeradores batch_payment_schedule_status

Value	Description
pending_2fa_approval	Pending 2FA approval
scheduled	Scheduled
rejected	Rejected
error	Scheduling error

Enumeradores payment_type

Value	Type	Description
bank_slip	string	Bank slip
collection_slip	string	Collection slip

Warning

The collection_slip value does not apply to this bank slip batch scheduling endpoint; for this flow, payment_type must be bank_slip.

Error Response

STATUS

4XX

Response Body

{
    "title": "Title",
    "description": "Description in english",
    "translation": "Portuguese description",
    "code": "Code"
}

HTTP code	QI code	Title	Description (eng)	Description (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	BIP000065	Bad Request	Payment verification time window exceeded.	Janela de tempo de verificação de pagamento excedida.