取消预约

此端点用于取消银行票据或征税发票的支付预约。

银行票据

这是常规银行票据（数字行不以数字8开头）。在银行间支付结算所（CIP/Núclea）注册，可在巴西中央银行授权的金融和支付机构付款。

征税发票

此类账单由服务特许经营商（水、电、电话和燃气账单）和政府机构（税务）开具。它们未在银行间支付结算所（CIP/Núclea）登记，因此返回的信息与银行票据不同。

Request

ENDPOINT

/account/ACCOUNT_KEY/payment_schedule/PAYMENT_SCHEDULE_KEY/cancel

MÉTODO

PATCH

请求路径参数

字段	类型	描述	字符数
`account_key` *	uuid4	账户唯一标识键。	36
`payment_schedule_key` *	uuid4	预约唯一标识键。	36

Response

成功响应

STATUS

200

Response Body: 银行票据支付预约已取消

{
   "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: 征税发票支付预约已取消

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

字段	类型	描述
`payment_key` *	uuid4	支付唯一标识键。
`request_control_key` *	uuid4	客户请求唯一标识键。
`payer_name` *	string	实际付款人名称。
`payer_document_number` *	string	实际付款人文件号码（CPF/CNPJ）。
`source_account_key` *	uuid4	被扣款账户密钥。
`paid_amount` *	number	实际支付金额。
`payment_date` *	string	预约日期。
`payment_type` *	enum	支付类型。
`bank_slip`	object	银行票据。
`collection_slip`	object	征税发票。
`payment_schedule_status` *	enum	预约状态。

payment_type 枚举值

枚举值	类型	描述
`bank_slip`	string	银行票据
`collection_slip`	string	征税发票

payment_schedule_status 枚举值

枚举值	描述
`canceled`	预约已取消

bank_slip 对象

字段	类型	描述
`barcode` *	string	条形码。
`digitable_line` *	string	数字行。
`payer_name` *	string	付款人名称。
`payer_document_number` *	string	付款人文件号码（CPF/CNPJ）。
`beneficiary_name` *	string	受益人名称。
`beneficiary_trading_name`	string	受益人商业名称。
`beneficiary_document_number` *	string	受益人文件号码（CPF/CNPJ）。
`beneficiary_bank_ispb` *	string	受益人银行 ISPB 代码。
`guarantor_name`	string	保证人名称。
`guarantor_document_number`	string	保证人文件号码（CPF/CNPJ）。
`expiration_date` *	string	到期日期。
`max_payment_date` *	string	最大支付日期。
`partial_payment_indicator` *	enum	部分付款指示符。
`registered_payment_amount`	string	已登记的总支付金额。
`nominal_amount` *	number	原始金额。
`total_amount` *	number	总金额。
`rebate_amount` *	number	折扣金额。
`discount_amount` *	number	优惠金额。
`fine_amount` *	number	罚款金额。
`interest_amount` *	number	利息金额。

partial_payment_indicator 枚举值

枚举值	描述
`allowed`	允许
`not_allowed`	不允许

collection_slip 对象

字段	类型	描述
`barcode`	string	条形码。
`digitable_line`	string	数字行。
`collection_name` *	string	协议名称。
`collection_document_number`	string	协议文件号码（CPF/CNPJ）。
`expiration_date` *	string	到期日期。
`total_amount` *	number	总金额。

错误响应

STATUS

4XX

Response Body

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

HTTP 代码	QI 代码	标题	描述（英文）	描述（葡文）
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	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

Request​

请求路径参数​

Response​

成功响应​

Response Body 参数​

payment_type 枚举值​

payment_schedule_status 枚举值​

bank_slip 对象​

partial_payment_indicator 枚举值​

collection_slip 对象​

错误响应​