Request batch scheduling of collection slip payments

This endpoint allows you to schedule multiple collection slips (utility/tax) in a single request.

Collection slip

This charge type is issued by utility companies (water, electricity, phone, gas) and public agencies (taxes). They are not registered with the Interbank Payment Clearinghouse (CIP/Núclea), so they do not return the same information as a bank slip.

Request

Request Endpoint

ENDPOINT

/bill_payment/account/ACCOUNT_KEY/payments_schedule/batch_collection_slip

METHOD

POST

Request Path Params

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

Request Body: Batch scheduling of collection slips

{
  "request_control_key": "b6804f32-101e-4702-8fbc-c2dbc4c2caec",
  "collection_slip_payment_schedules": [
    {
      "request_control_key": "c7915a43-212f-5813-9adc-d3ed5d3d3bfd",
      "digitable_line": "836200000138892100450006762142420244046000010192",
      "payment_amount": 1389.21,
      "payment_date": "2026-04-10"
    },
    {
      "request_control_key": "d8a26b54-323a-4924-0aed-e4fe6e4e4c0e",
      "barcode": "836200000138892100450006762142420244046000010192",
      "payment_amount": 550.10,
      "payment_date": "2026-04-15"
    }
  ]
}

Body Params

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

Each element of collection_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.

Response

Success Response

STATUS

202

Response Body: Batch schedule created

{
  "batch_payment_schedule_key": "33860ad0-bcb0-47b7-bbe7-c7e3ec2fc61a",
  "request_control_key": "ae4508df-f2cb-4e28-9f04-a19b7f2758c9",
  "account_key": "daae79e6-ee8b-449f-aa1e-96959d5d5a72",
  "total_amount": 1939.31,
  "batch_payment_schedule_status": "scheduled",
  "payment_type": "collection_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 bank_slip value does not apply to this collection slip batch scheduling endpoint; for this flow, payment_type must be collection_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)
400	BIP000032	Bad Request	The bill sent does not correspond to a collection slip.	A conta enviada não corresponde a uma fatura de recolhimento.
400	BIP000033	Bad Request	The barcode or digitable line of the collection slip must have 44 or 48 characters.	O código de barras ou linha digitável da fatura de recolhimento deve ter 44 ou 48 caracteres.
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.