Request bank slip batch scheduling with 2FA

This endpoint allows requesting batch scheduling for bank slips in a single request, with two-factor authentication when applicable.

Bank slip

A traditional bank slip (digitable line does not start with 8). It is registered in the Interbank Payment Chamber (CIP/Nuclea) and can be paid through financial and payment institutions authorized 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 identifier key.	36

Request Body: Bank slip batch scheduling

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

Field	Type	Description
`request_control_key` *	uuid4	Unique client request identifier key (batch).
`bank_slip_payment_schedules` *	array	List of bank slip schedules. Limit of 1000 items per request.
`tfa_info` *	object	Object containing the approver document and token delivery channel.

Each element in bank_slip_payment_schedules must contain:

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

Warning

For each item, payment_amount must follow the bank slip rules returned by the lookup. If partial payment is not allowed, the amount must match the updated total amount.

Object tfa_info

Field	Type	Description
`approver_document_number`*	string	Approver document number (CPF/CNPJ).
`contact_type`*	enumerator	Authentication token delivery channel

Enumerator	Description
sms	Send token via SMS
email	Send token via email

Response

Success Response

STATUS

202

Response Body: Scheduling batch pending two-factor approval

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

Field	Type	Description
`batch_payment_schedule_key` *	uuid4	Unique batch scheduling identifier key.
`request_control_key` *	uuid4	Unique client request identifier key (batch).
`account_key` *	uuid4	Debited account key.
`total_amount` *	number	Sum of (`payment_amount`) values for batch items.
`batch_payment_schedule_status` *	enum	Batch scheduling status after request.
`payment_type` *	enum	Payment type.

Enumerators batch_payment_schedule_status

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

Enumerators payment_type

Enumerator	Type	Description
`bank_slip`	string	Bank slip
`collection_slip`	string	Collection slip

Warning

The collection_slip enumerator does not apply to the bank slip batch scheduling flow for this endpoint; expected payment_type value is bank_slip.

Error Response

STATUS

4XX

Response Body

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

HTTP Code	QI Code	Title	Description (eng)	Description (pt-br)
403	BIP000010	Forbidden	User is not allowed to do this action	User is not allowed to do this action
404	BIP000011	Not Found	The source account key was not found.	The source account key was not found.
400	BIP000012	Bad Request	It was not possible to consult the source account at this time. Please try again in a few minutes.	It was not possible to consult the source account at this time. Please try again in a few minutes.
400	BIP000024	Bad Request	Request control key already exists.	Request control key already exists.
400	BIP000052	Bad Request	Given document number does not belong to an approver for this account	Given document number does not belong to an approver for this account
400	BIP000053	Bad Request	Error getting approver date	Error getting approver date
400	BIP000054	Bad Request	TFA info required	TFA info required
400	BIP000055	Bad Request	Error sending verification token	Error sending verification token
400	BIP000065	Bad Request	Payment verification time window exceeded.	Payment verification time window exceeded.

Request​

Request Endpoint​

Request Path Params​

Body Params​

Object tfa_info​

Response​

Success Response​

Response Body Params​

Enumerators batch_payment_schedule_status​

Enumerators payment_type​

Error Response​