Cancel schedule

This endpoint is used to cancel a scheduled payment of a Boleto or Collection Invoice.

Boleto

This is the conventional boleto (with 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.

Collection Invoice

This type of charge is issued by utility companies (water, electricity, telephone, and gas bills) and public entities (taxes). They are not registered with the Interbank Payment Clearinghouse (CIP/Núclea) and, therefore, do not return the same information as a boleto.

Request

ENDPOINT

/account/ACCOUNT_KEY/payment_schedule/PAYMENT_SCHEDULE_KEY/cancel

METHOD

PATCH

Request Path Params

Field	Type	Description	Characters
account_key *	uuidv4	Unique account identification key.	36
payment_schedule_key *	uuidv4	Unique schedule identification key.	36

Response

Success Response

STATUS

200

Response Body: Scheduled payment of boleto cancelled

{
   "payment_key":"c4325104-d60b-44f3-aae4-49155564a2ea",
   "request_control_key":"b713b2f6-2f48-4d18-b0c9-7186e4edf189",
   "payer_name":"COOPERATIVA INDUSTRIAL MURILO",
   "payer_document_number":"00037025000160",
   "source_account_key":"6dc89d57-fac7-4643-b151-cd2ca0a7f68f",
   "paid_amount":1050.1,
   "payment_date":"2024-04-03",
   "payment_type":"bank_slip",
   "bank_slip": {
        "bank_slip_key":"95080ffd-3ac5-48d7-b3fe-659e4aaba81a",
        "barcode":"00193967000009910000000003615574000000002417",
        "digitable_line":"00190000090361557400500000024174396700000991000",
        "payer_name":"COOPERATIVA TESTE",
        "payer_document_number":"00037025000160",
        "beneficiary_name":"TESTE EQUIPAMENTOS E SERVICOS LTDA",
        "beneficiary_trading_name":"TESTE EQUIPAMENTOS E SERVICOS LTDA",
        "beneficiary_document_number":"52069937000117",
        "beneficiary_bank_ispb":"00000000",
        "guarantor_name":null,
        "guarantor_document_number":null,
        "expiration_date":"2024-03-29",
        "max_payment_data": "2026-03-29",
        "partial_payment_indicator":"allowed",
        "registered_payment_amount":9029.0,
        "nominal_amount":9910.0,
        "total_amount":10129.1,
        "rebate_amount":0.0,
        "discount_amount":0.0,
        "fine_amount":0.0,
        "interest_amount":219.1
    },
   "collection_slip":null,
   "payment_schedule_status":"canceled"
}

Response Body: Scheduled payment of collection invoice cancelled

{
  "payment_key": "33860ad0-bcb0-47b7-bbe7-c7e3ec2fc61a",
  "request_control_key": "ae4508df-f2cb-4e28-9f04-a19b7f2758c9",
  "payer_name": "COOPERATIVA INDUSTRIAL MURILO",
  "payer_document_number": "62069937000118",
  "source_account_key": "daae79e6-ee8b-449f-aa1e-96959d5d5a72",
  "paid_amount": 1389.21,
  "payment_date": "2024-04-30",
  "payment_type": "collection_slip",
  "bank_slip": null,
  "collection_slip": {
    "barcode": null,
    "digitable_line": "836200000138892100450006762142420244046000010192",
    "collection_name": "CIA ULTRAGAZ SA-COD",
    "collection_document_number": "00394460005887",
    "expiration_date": "2024-04-15",
    "total_amount": 1389.21
  },
  "payment_schedule_status": "canceled"
}

Response Body Params

Field	Type	Description
payment_key *	uuid4	Unique payment identification key.
request_control_key *	uuid4	Unique identification key for the client's request.
payer_name *	string	Name of the effective payer.
payer_document_number *	string	Document number of the effective payer (CPF/CNPJ).
source_account_key *	uuid4	Key of the debited account.
paid_amount *	number	Amount effectively paid.
payment_date *	string	Scheduling date.
payment_type *	enum	Payment type.
bank_slip	object	Boleto.
collection_slip	object	Collection invoice.
payment_schedule_status *	enum	Schedule status.

Enumerators payment_type

Enumerator	Type	Description
bank_slip	string	Boleto
collection_slip	string	Collection invoice

Enumerators payment_schedule_status

Enumerator	Description
canceled	Schedule canceled

Object bank_slip

Field	Type	Description
barcode *	string	Barcode.
digitable_line *	string	Digitable line.
payer_name *	string	Payer's name.
payer_document_number *	string	Payer's document number (CPF/CNPJ).
beneficiary_name *	string	Beneficiary's name.
beneficiary_trading_name	string	Beneficiary's trade name.
beneficiary_document_number *	string	Beneficiary's document number (CPF/CNPJ).
beneficiary_bank_ispb *	string	ISPB code of the beneficiary's bank.
guarantor_name	string	Name of the guarantor.
guarantor_document_number	string	Guarantor's document number (CPF/CNPJ).
expiration_date *	string	Due date.
max_payment_date *	string	Maximum payment date.
partial_payment_indicator *	enum	Partial payment indicator.
registered_payment_amount	string	Total registered payment amount.
nominal_amount *	number	Original amount.
total_amount *	number	Total amount.
rebate_amount *	number	Rebate amount.
discount_amount *	number	Discount amount.
fine_amount *	number	Fine amount.
interest_amount *	number	Interest amount.

Enumerators partial_payment_indicator

Enumerator	Description
allowed	Allowed
not_allowed	Not allowed

Object collection_slip

Field	Type	Description
barcode	string	Barcode.
digitable_line	string	Digitable line.
collection_name *	string	Name of the agreement.
collection_document_number *	string	Document number of the agreement (CPF/CNPJ).
expiration_date *	string	Due date.
total_amount *	number	Total amount.

Error Response

STATUS

4XX

Response Body

{
    "title": "Título",
    "description": "Description in english",
    "translation": "Description em português",
    "code": "Código"
}

HTTP Code	QI Code	Title	Description (eng)	Description (pt-br)
400	BIP000001	Bad Request	The barcode or digitable line must have 44 or 47 characters.	O código de barras ou linha digitável deve ter 44 ou 47 caracteres.
400	BIP000002	Bad Request	The bill sent does not correspond to a bank slip.	A conta enviado não corresponde a um boleto bancário.
400	BIP000003	Bad Request	The digitable line sent is invalid.	A linha digitável enviada é inválida.
404	BIP000004	Not Found	The bank slip was not found.	O boleto não foi encontrado.
400	BIP000005	Bad Request	It was not possible to consult the bank slip at this time. Please try again in a few minutes.	Não foi possível consultar o boleto neste momento. Por favor, tente novamente em alguns minutos.
400	BIP000006	Bad Request	Bank slip already written off	Boleto já baixado
400	BIP000007	Bad Request	Bank slip blocked for payment	Boleto bloqueado para pagamento
400	BIP000008	Bad Request	Bank slip already paid	Boleto já pago
400	BIP000009	Bad Request	Invalid bank slip. Please consult issuing bank	Boleto inválido. Favor consultar banco emissor