BolePix Issuance

Attention

Before registering a bolePix, it is necessary that an active Random Pix Key exists in the account where the bank slip will be registered.

At QI Tech, it is possible to issue a bank slip linked to a Pix QR Code.

This way, the payer can make the payment of the bank slip through the typable line of the registered bank slip or through reading the Pix QR Code linked to this bank slip.

In cases where the payer makes the payment through reading the Pix QR Code, the financial settlement of the payment will be instantaneous, with bank returns as well as webhooks regarding the settlement of this bank slip being generated in the same way as a common bank slip.

Request

ENDPOINT

/multibank_instruction

METHOD

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

Field	Type	Description	Characters
`use_multi_process`	boolean	Indicates whether the processing of registration occurrences will be sent for queue processing or if they will be processed sequentially. If this parameter is set to `true`, it is mandatory to send our bank number `our_number` in the registration occurrence payload.	-

Body params

Field	Type	Description	Characters
`occurrences` *	array of objects	List of occurrences to be processed.	Occurrences object

Occurrences object

Field	Type	Description	Characters
`amount` *	double	Bank slip amount.	-
`automatic_bankruptcy_protest`	boolean	Automatic protest configuration.	-
`bank_teller_instructions`	string	Teller instructions (Bank slip message/observations).	-
`beneficiary_account_key`	string	Beneficiary account key.	-
`beneficiary_key`	string	Beneficiary key.	-
`days_to_bankruptcy_protest`	int	Number of days for automatic bankruptcy protest submission.	-
`document_number`	string	Document number.	-
`expiration` *	string	Due date.	-
`fine_percentage`	string	Fine percentage	-
`interest_daily_value`	string	Daily interest value in reais	-
`occurrence_type` *	string	Occurrence type.	-
`payer_address`	string	Payer address.	-
`payer_document` *	string	Payer document (CPF or CNPJ).	-
`payer_name` *	string	Payer name.	-
`payer_person_type` *	string	Payer person type.	-
`payer_postal_code_root`	string	The first five digits of the ZIP code.	-
`payer_postal_code_suffix`	string	The last three digits of the ZIP code.	-
`printing_policy`	string	Bank slip printing policy	-
`registration_institution_enumerator` *	string	Will always be `qi_scd`.	`qi_scd`
`requester_profile` *	string	Portfolio number.	02
`requester_profile_code` *	string	Portfolio code composed as follows: "329-portfolio-agency-7_digit_account". NOTE: QI Tech's default collection portfolio is number "09".	-
`notification`	object	Portfolio number.	Notification object
`discounts`	object	List of objects with discount information.	Discounts object
`guarantor_name`	string	Guarantor name.	-
`guarantor_document_root`	string	Guarantor CNPJ base.	-
`guarantor_document_subsidiary`	string	Parent or subsidiary CNPJ information.	-
`guarantor_document_digit`	string	CNPJ verification digit.	-
`pix_key` *	string	Pix key where the Pix QR Code linked to the bolePix will be registered.	100

"pix_key" Field

The "pix_key" can be a CPF, CNPJ, Email, Phone or a Random Key (UUID), following these formats:

CPF: Integer number with 11 digits.

CNPJ: Integer number with 14 digits.

Email: Text containing at least one "@".

Phone: Text containing the following values: "+55" + "Phone area code" + "Integer phone number with minimum 8 and maximum 9 digits". Ex: "+5511987654321".

Random Key: UUID.

Notification object

Field	Type	Description	Characters
`document_number` *	string	Document number of the user who will receive the notification.	-
`email` *	string	Email of the user who will receive the notification.	-
`name` *	string	Name of the user who will receive the notification.	-
`phone` *	object	Object containing phone information of the user who will receive the notification.	Phone object
`send_2_way` *	boolean	Send duplicate copy issuance notifications.	true/false
`send_after_due_date` *	boolean	Send notifications after the bank slip due date.	true/false
`send_before_due_date` *	boolean	Send notifications before the bank slip due date.	true/false
`send_on_protest` *	boolean	Send protest notifications.	true/false

Phone object

Field	Description	Example	Max Characters
`country_code`	string	Phone DDI code (https://ddi.guiamais.com.br/)	3
`area_code`	string	Phone DDD code (https://ddd.guiamais.com.br/)	2
`number`	string	Phone number (numbers only)	10

Discounts object

Field	Description	Example	Max Characters
`discount_value`	float	Discount value.	3
`discount_number`	int32	Order in which the discount should be applied.	2
`discount_limit_date`	date	Discount limit 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

Field	Type	Description	Characters
`bank_slips`	list	List with information of registered bank slips if the `use_multi_process` parameter is set to `false`.	Bank Slip Object
`file_info`	list	File information.	File Info Object
`occurrence_stats`	object	File information.	File Info Object
`semantic_errors`	list	List of errors in processing each bank slip. Will be returned if there is any processing error and if the `use_multi_process` parameter is set to `false`.	Semantic Error Object

Bank_slip object

Field	Type	Description	Characters
`amount`	float	Bank slip amount.	-
`bank_slip_key`	uuid	Unique identification key of the bank slip at QI Tech.	36
`bank_slip_status`	enum	Unique identification key of the bank slip at QI Tech.	Bank_slip_status Enumerators
`barcode`	string	Bank slip barcode.	44
`beneficiary_account_key`	uuid	Unique identification key of the account where the bank slip was registered.	36
`beneficiary_key`	uuid	Unique identification key of the account holder where the bank slip was registered.	36
`digitable_line`	uuid	Bank slip typable line.	47
`expiration`	string	Bank slip due date.	10
`nfe_key`	string	Unique identification key of the electronic invoice.	-
`nfe_url`	string	Electronic invoice URL.	-
`our_number`	int	Our bank number. It is a sequential identification number of this bank slip in relation to the account (collection portfolio) where it was registered. Its value can be provided in the bank slip registration request. If not provided, QI Tech will generate a value for this field (being an incremental value, ex: 1st bank slip registered in the account will have an `our_number` value of 1, the 16th bank slip registered in the account will have an `our_number` value of 16).	-
`participant_control_number`	string	Participant control number.	10
`payer_postal_code`	string	Bank slip payer ZIP code.	8
`protest_status`	string	Bank slip protest status, if protest has been requested.	Protest_status Enumerators
`qr_code`	object	Object with information of the Pix QR Code linked to the bank slip.	Qr_code object

Qr_code object

Field	Type	Description	Characters
`pix_key`	string	Pix key where the Pix QR Code linked to the bank slip was registered.	100
`qr_code_key`	uuid	Unique identification key of the Pix QR Code linked to the bank slip.	36
`qr_code_url`	uuid	Copy and Paste Pix URL of the Pix QR Code linked to the bank slip.	36

Bank_slip_status enumerators

Enumerator	Description
`accepted`	Bank slip accepted for processing
`registered`	Bank slip registration completed in the bank slip registration chamber
`paid`	Bank slip payment amount was credited to the beneficiary's account
`written_off`	Bank slip written off (bank slip is no longer payable)
`rejected`	Bank slip registration rejected by the bank slip registration chamber
`payment_notice`	Notice that bank slip payment was processed at the paying bank (but settlement to the beneficiary's account has not yet occurred)
`notary_office_payment_notice`	Notice that payment of a protested bank slip was processed at the paying bank (but the notary office has not yet transferred the payment and settlement to the beneficiary's account has not yet occurred)

Protest_status enumerators

Enumerator	Description
`not_protested`	Bank slip has no protest request.
`protest_requested`	Bank slip with protest request being processed by QI Tech.
`notary_office_entry`	Bank slip protest request was accepted by the notary office.
`protest_cancel_requested`	Protest cancellation request being processed by QI Tech.
`notary_office_exit`	Bank slip protest was withdrawn from the notary office.
`protested`	Protest was confirmed by the notary office and the bank slip is protested.
`paid_at_notary_office`	Notary office identified the bank slip protest payment and is processing the payment transfer to QI Tech.
`judicially_suspended`	Judicially suspended protest.
`protest_remove_requested`	Protest removal request was accepted by the notary office.

Request​

Query params​

Body params​

Occurrences object​

Notification object​

Phone object​

Discounts object​

Response​

Response Params​

Bank_slip object​

Qr_code object​

Bank_slip_status enumerators​

Protest_status enumerators​