跳到主要内容

简介

银行票据(Boleto bancário)

银行票据通常与收款业务相关。其特点是可输入的数字行以数字 8 开头。银行票据在银行同业清算所(CIP/Núclea)进行登记,可在巴西中央银行授权的金融机构和支付机构进行支付。

收款钱包(Carteira de cobrança)

首先需要说明的是,在本文档中,收款钱包称为 requester_profile。收款钱包必然关联到一个账户,并带有特定的默认配置(如利息、罚款、抗议等),用于银行票据的登记。一旦在创建或编辑收款钱包时设置了这些默认配置,每当用户登记票据时,若未发送某项配置,将使用该参数的默认配置。

示例

创建收款钱包时,用户为钱包设置了罚款配置:若付款人延迟付款 5 天或以上,将收取 R$10.00 的罚款。登记票据时,该配置可被覆盖;例如,可以选择收取 R$15.00 的罚款,甚至不收取任何罚款。但是,如果在登记票据时没有覆盖该配置,则采用钱包的默认配置(付款人延迟超过 5 天时收取 R$10.00 罚款)。

可以为同一账户创建多个收款钱包,账户开设时会自动创建一个初始钱包(无任何默认配置)。创建多个收款钱包的可能性允许用户创建具有不同默认配置的钱包;而默认配置则简化了具有相同配置的多张票据的登记,因为在登记票据时无需每次都发送罚款、利息等配置。

票据状态机

票据在其生命周期中可能经历以下状态:

枚举值翻译描述
accepted已接受票据已接受,等待 CIP/Núclea 确认
rejected已拒绝票据登记请求未被接受
registered已登记票据已在 CIP/Núclea 登记
payment_blocked已冻结支付票据因进入抗议流程而在 CIP/Núclea 被冻结支付
written_off已核销票据已核销(不再可支付)
payment_notice支付通知票据已支付并核销,但尚未完成财务清算
paid已支付票据已支付、核销并完成财务清算

状态转换

  • accepted -> rejected:票据登记未被 CIP/Núclea 接受;
  • accepted -> registered:票据登记被 CIP/Núclea 接受;
  • registered -> written_off:票据未经支付被核销;
  • registered -> payment_notice:票据已支付并核销,但尚未完成财务清算;
  • payment_notice -> paid:支付后,票据完成财务清算;
  • registered -> payment_blocked:票据支付被冻结,因抗议流程开始;
  • payment_blocked -> notary_office_payment_notice:票据在公证处支付并核销,但尚未完成财务清算;
  • notary_office_payment_notice -> paid:在公证处支付后,票据完成财务清算;
  • payment_blocked -> written_off:票据已被抗议。
注意

对于配置了部分付款的票据,状态转换方式有所不同。收到付款后,若另一家银行发送的是银行间部分核销,配置了部分付款的票据仍保持 registered 状态。您会正常收到 payment noticepayment 的 webhook 通知,但票据保持 registered 状态。只有当付款银行通过 CIP/Núclea 发送银行间全额核销时,票据才会转为 payment_notice 状态,随后转为 paid 状态。若希望在任何时候核销票据,或总金额已支付但另一家机构未发送银行间全额核销,您可以发送核销指令

对于信用卡类型(credit_card)的票据,请注意这些票据不会收到银行间全额核销。因此,客户始终有责任手动核销票据,否则票据将在最大支付日期(根据 max_payment_days 配置)后 D+7 自动核销。

票据登记

通过 API

标准登记流程

若系统通过标准登记流程收到票据登记请求,且该请求被接受(即发送的信息无任何不一致),将返回状态为 accepted 的票据,但这并不意味着该票据会被实际登记。在将票据发送至 CIP/Núclea 并收到响应后,票据将转为 rejectedaccepted 状态。

批量登记流程

批量发行票据以异步方式进行,若任何票据在验证中失败,则所有票据均不会被登记。当票据状态发生变化时,申请人将通过 webhook 收到通知。更多详情请查阅完整文档

即时登记流程

票据登记还有另一种选择:即时登记流程。在该流程中,票据登记以同步方式处理,API 响应直接返回票据是否被接受或拒绝;即响应返回的票据已具有 acceptedrejected 状态。Núclea/CIP 关于票据登记的确认/拒绝时间包含在该端点的响应时间内。

通过汇款文件

通过文件请求登记票据与通过 API 登记的最终结果完全相同。区别在于,通过文件登记时,需要将文件处理时间计入票据登记的总时间。因此,通常比通过 API 登记耗时更长。

另一方面,通过文件登记时,可以一次性登记大量票据。