发行 bolePix

注意

在注册 bolePix 之前，需要在票据将要登记的账户中存在一个有效的随机 Pix 密钥。

在 QI Tech，可以发行与 Pix QR Code 关联的票据。

通过这种方式，付款人可以通过已登记票据的可输入行或通过扫描与该票据关联的 Pix QR Code 来支付票据。

在付款人通过扫描 Pix QR Code 付款的情况下，付款的财务清算是即时的，银行回报以及有关此票据清算的 webhook 将以与普通票据相同的方式生成。

Request

ENDPOINT

/multibank_instruction

MÉTODO

POST

Request Body

{
	"occurrences": [{
		"amount": 1000,
		"automatic_bankruptcy_protest": false,
		"bank_teller_instructions": "Não pagar após vencimento.",
		"beneficiary_account_key": "8a35e639-8420-4f6c-9647-c2515e5381ef",
		"beneficiary_key": "3c866e34-23fe-46c2-a8b0-e39ca4348923",
		"days_to_bankruptcy_protest": 0,
		"document_number": "123456/01",
		"expiration": "2020-06-01",
		"fine_percentage": "3",
		"interest_daily_value": "0.34",
		"occurrence_type": "registration",
		"payer_address": "Rua Carlos Sampaio, 123",
		"payer_document": "41184562067",
		"payer_name": "João Ninguem",
		"payer_person_type": "natural",
		"payer_postal_code_root": "15800",
		"payer_postal_code_suffix": "020",
		"printing_policy": "no_printing",
		"registration_institution_enumerator": "qi_scd",
		"requester_profile": "09",
		"requester_profile_code": "329-09-0001-0000002",
        "pix_key": "1684629c-d52a-4941-92f5-410907316129" 
	}]
}

Query params

字段	类型	描述	字符数
`use_multi_process`	boolean	指示登记指令的处理是发送至队列处理还是按顺序处理。若此参数值为 `true`，则在登记指令的 payload 中必须发送我们的银行编号 `our_number`	-

Body params

字段	类型	描述	字符数
`occurrences` *	array of objects	待处理的指令列表	Objeto occurrences

Objeto occurrences

字段	类型	描述	字符数
`amount` *	double	票据金额	-
`automatic_bankruptcy_protest`	boolean	自动抗议配置	-
`bank_teller_instructions`	string	出纳指令（票据消息/备注）	-
`beneficiary_account_key`	string	受益人账户键	-
`beneficiary_key`	string	受益人键	-
`days_to_bankruptcy_protest`	int	自动发送破产抗议的天数	-
`document_number`	string	文件编号	-
`expiration` *	string	到期日	-
`fine_percentage`	string	罚款百分比	-
`interest_daily_value`	string	每日利息金额（巴西雷亚尔）	-
`occurrence_type` *	string	指令类型	-
`payer_address`	string	付款人地址	-
`payer_document` *	string	付款人文件（CPF 或 CNPJ）	-
`payer_name` *	string	付款人姓名	-
`payer_person_type` *	string	付款人类型	-
`payer_postal_code_root`	string	邮政编码前五位	-
`payer_postal_code_suffix`	string	邮政编码后三位	-
`printing_policy`	string	票据打印策略	-
`registration_institution_enumerator` *	string	始终为 `qi_scd`	`qi_scd`
`requester_profile` *	string	钱包编号	02
`requester_profile_code` *	string	钱包代码，格式为："329-钱包-机构-7位账号"。注：QI Tech 默认催收钱包编号为"09"	-
`notification`	object	钱包编号	Objeto notification
`discounts`	object	包含折扣信息的对象列表	Objeto discounts
`guarantor_name`	string	背书人姓名	-
`guarantor_document_root`	string	背书人 CNPJ 基础部分	-
`guarantor_document_subsidiary`	string	CNPJ 总部或分支机构信息	-
`guarantor_document_digit`	string	CNPJ 验证位	-
`pix_key` *	string	关联至 bolePix 的 Pix QR Code 将登记的 Pix 密钥	100

字段 "pix_key"

"pix_key" 可以是 CPF、CNPJ、电子邮件、手机号码 或 随机密钥（UUID），格式如下：

CPF： 11 位整数。

CNPJ： 14 位整数。

电子邮件： 包含至少一个"@"的文本。

手机号码： 包含以下值的文本："+55" + "手机 DDD 区号" + "至少 8 位最多 9 位的手机号码整数"。例如："+5511987654321"。

随机密钥： UUID。

Objeto notification

字段	类型	描述	字符数
`document_number` *	string	接收通知用户的文件编号	-
`email` *	string	接收通知用户的电子邮件	-
`name` *	string	接收通知用户的姓名	-
`phone` *	object	包含接收通知用户电话信息的对象	Objeto phone
`send_2_way` *	boolean	发送补发通知	true/false
`send_after_due_date` *	boolean	在票据到期后发送通知	true/false
`send_before_due_date` *	boolean	在票据到期前发送通知	true/false
`send_on_protest` *	boolean	发送抗议通知	true/false

Objeto phone

字段	类型	描述	最大字符数
`country_code`	string	电话国际区号	3
`area_code`	string	电话地区区号	2
`number`	string	电话号码（仅数字）	10

Objeto discounts

字段	类型	描述	字符数
`discount_value`	float	折扣金额	-
`discount_number`	int32	折扣应用顺序	-
`discount_limit_date`	date	折扣适用截止日期	10

Response

STATUS

200

Response Body

{
  "bank_slips": [
    {
      "amount": "649.73",
      "bank_slip_key": "4bc636d0-1e41-4ce6-801c-475814bf4dcf",
      "bank_slip_status": "accepted",
      "barcode": "32991916500000649730001090000699935200347340",
      "beneficiary_account_key": "1c977186-9167-4ef1-b27d-08483429f74c",
      "beneficiary_key": "f01d4877-b1cc-4f4a-a8f9-952c2cef9ca8",
      "digitable_line": "32990001039000069993552003473403191650000064973",
      "expiration": "2022-11-10",
      "nfe_key": null,
      "nfe_url": null,
      "our_number": 6999352,
      "participant_control_number": null,
      "payer_postal_code": "38050000",
      "protest_status": "not_protested",
      "qr_code": {
        "pix_key": "9de04466-0b02-4263-9c28-9cdc0fb638bb",
        "qr_code_key": "881979cb-1c15-4dea-a05e-316caae22f5e",
        "qr_code_url": "00020126970014br.gov.bcb.pix2575qrcode-h.sandbox.qitech.app/bacen/cobv/881979cb-1c15-4dea-a05e-316caae22f5e5204000053039865802BR5925LOTEAMENTO RESIDENCIAL PO6014PORTO NACIONAL61087750000062070503***630414B8"
      }
    }
  ],
  "file_info": {
    "beneficiary_code": null,
    "beneficiary_name": null,
    "file_sequence_id": null,
    "file_type_identifier": null,
    "file_type_literal": null,
    "service_code": null,
    "service_literal": null,
    "wrote_at": null
  },
  "occurrence_stats": {
    "bank_slip_edit": 0,
    "bankruptcy_protest_request": 0,
    "cancel_rebate": 0,
    "extension": 0,
    "notary_office_entry": 0,
    "notary_office_exit": 0,
    "notary_office_payment": 0,
    "notification": 0,
    "payment": 0,
    "payment_notice": 0,
    "payment_write_off": 0,
    "protest_cancel_and_write_off_request": 0,
    "protest_cancel_request": 0,
    "protest_remove_request": 0,
    "protest_request": 0,
    "rebate": 0,
    "registration": 1,
    "write_off": 0
  },
  "semantic_errors": []
}

STATUS

400

Response Body

{
  "data": "{\"title\": \"Bad Request\", \"description\": \"Invalid request body.\", \"translation\": \"Corpo da requisição inválido.\", \"extra_fields\": {}, \"code\": \"LEG000069\"}"
}

Response Params

字段	类型	描述	字符数
`bank_slips`	list	当 `use_multi_process` 参数值为 `false` 时，返回已登记票据的信息列表	Objeto Bank Slip
`file_info`	list	文件信息	Objeto File Info
`occurrence_stats`	object	文件信息	Objeto File Info
`semantic_errors`	list	每张票据处理过程中的错误列表。当处理中存在错误且 `use_multi_process` 参数值为 `false` 时返回	Objeto Semantic Error

Objeto bank_slip

字段	类型	描述	字符数
`amount`	float	票据金额	-
`bank_slip_key`	uuid	QI Tech 票据唯一标识键	36
`bank_slip_status`	enum	票据状态	Enumeradores bank_slip_status
`barcode`	string	票据条形码	44
`beneficiary_account_key`	uuid	登记票据的账户唯一标识键	36
`beneficiary_key`	uuid	受益人唯一标识键	36
`digitable_line`	string	票据可输入行	47
`expiration`	string	票据到期日	10
`nfe_key`	string	电子发票唯一标识键	-
`nfe_url`	string	电子发票 URL	-
`our_number`	int	银行编号	-
`participant_control_number`	string	参与者控制编号	10
`payer_postal_code`	string	付款人邮政编码	8
`protest_status`	string	票据抗议状态	Enumeradores protest_status
`qr_code`	object	与票据关联的 Pix QR Code 信息	Objeto qr_code

Objeto qr_code

字段	类型	描述	字符数
`pix_key`	string	关联至票据的 Pix QR Code 登记的 Pix 密钥	100
`qr_code_key`	uuid	关联至票据的 Pix QR Code 唯一标识键	36
`qr_code_url`	string	关联至票据的 Pix QR Code 的复制粘贴链接 URL	-

Enumeradores bank_slip_status

枚举值	描述
`accepted`	票据已接受处理
`registered`	票据登记已在票据登记所完成
`paid`	票据付款金额已贷记至受益人账户
`written_off`	票据已核销（不可再付款）
`rejected`	票据登记被票据登记所拒绝
`payment_notice`	票据付款已在付款银行处理的通知（但受益人账户的清算尚未发生）
`notary_office_payment_notice`	已抗议票据的付款已在付款银行处理的通知（但公证处尚未转账，受益人账户的清算尚未发生）

Enumeradores protest_status

枚举值	描述
`not_protested`	票据无抗议申请
`protest_requested`	QI Tech 正在处理抗议申请
`notary_office_entry`	票据抗议申请已被公证处接受
`protest_cancel_requested`	QI Tech 正在处理取消抗议申请
`notary_office_exit`	票据抗议已从公证处撤回
`protested`	公证处已确认抗议，票据处于抗议状态
`paid_at_notary_office`	公证处已识别票据抗议的付款，正在处理向 QI Tech 的付款转账
`judicially_suspended`	抗议已被司法暂停
`protest_remove_requested`	撤销抗议申请已被公证处接受

Request​

Query params​

Body params​

Objeto occurrences​

Objeto notification​

Objeto phone​

Objeto discounts​

Response​

Response Params​

Objeto bank_slip​

Objeto qr_code​

Enumeradores bank_slip_status​

Enumeradores protest_status​