Pular para o conteúdo principal

Emissão de um bolePix

Atenção

Antes de registrar um bolePix é necessário que a exista uma Chave Pix Aleatória ativa na conta onde o boleto será registrado.

Na QI Tech, é possível realizar a emissão de um boleto vinculado a um QR Code Pix.

Desta forma, o sacado poderá realizar o pagamento do boleto através da linha digitável do boleto registrado ou então através da leitura do QR Code Pix vinculado a este boleto.

Nos casos em que o sacado realizar o pagamento através de leitura do QR Code Pix, a liquidação financeira do pagamento será instatânea, sendo que os retornos bancários, bem com os webhooks a respeito da liquidação deste boleto serão gerados da mesma forma que um boleto comum.

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

CampoTipoDescriçãoCaracteres
use_multi_processbooleanIndica se o processamento das ocorrências de registro serão enviados para processamento em fila ou se serão processados de forma sequencial. Caso seja este parâmetro seja informado como true, é obrigatório o envio do nosso número bancário our_number no payload da ocorrência de registro.-

Body params

CampoTipoDescriçãoCaracteres
occurrences *array of objectsLista de ocorrências a serem processadas.Objeto occurrences

Objeto occurrences

CampoTipoDescriçãoCaracteres
amount *doubleValor do boleto.-
automatic_bankruptcy_protestbooleanConfiguração de protesto automático.-
bank_teller_instructionsstringInstruções ao caixa (Mensagem/Observações do boleto).-
beneficiary_account_keystringChave da conta do beneficiário.-
beneficiary_keystringChave do beneficiário.-
days_to_bankruptcy_protestintNúmero de dias para envio automático de protesto falimentar.-
document_numberstringNumero do documento.-
expiration *stringData de vencimento.-
fine_percentagestringPorcentagem de multa-
interest_daily_valuestringValor de juros por dia em reais-
occurrence_type *stringTipo de ocorrência.-
payer_addressstringEndereço do pagador.-
payer_document *stringDocumento do pagador (CPF ou CNPJ).-
payer_name *stringNome do pagador.-
payer_person_type *stringTipo de pessoa pagante.-
payer_postal_code_rootstringOs cinco primeiros digitos do CEP.-
payer_postal_code_suffixstringOs três últimos dígitos do CEP.-
printing_policystringPolítica de impressão do boleto-
registration_institution_enumerator *stringSerá sempre qi_scd.qi_scd
requester_profile *stringNúmero da carteira.02
requester_profile_code *stringCódigo da carteira composto da seguinte forma: "329-carteira-agencia-conta_com_7_digitos". OBS: a carteira de cobrança padrão QI Tech é de numero "09".-
notificationobjectNúmero da carteira.Objeto notification
discountsobjectLista de objetos com informações de desconto.Objeto discounts
guarantor_namestringNome do sacador avalista.-
guarantor_document_rootstringBase do CNPJ do sacador avalista.-
guarantor_document_subsidiarystringInformação de CNPJ de matriz ou filial.-
guarantor_document_digitstringDígito verificador do CNPJ.-
pix_key *stringChave Pix onde o QR Code Pix vinculado ao bolepix será registrado.100
Campo “pix_key

A “pix_key” pode ser um CPF, CNPJ, E-mail, Celular ou uma Chave Aleatória (UUID), seguindo as seguintes formatações:

CPF: Número inteiro com 11 dígitos.

CNPJ: Número inteiro com 14 dígitos.

E-mail: Texto contendo ao menos um “@”.

Celular: Texto contendo os seguintes valores: “+55” + “DDD do celular“ + “Número Inteiro do Celular com no mínimo 8 e no máximo 9 dígitos”. Ex: “+5511987654321“.

Chave Aleatória: UUID.

Objeto notification

CampoTipoDescriçãoCaracteres
document_number *stringNumero de documento do usuario que vai receber a notificação.-
email *stringEmail do usuario que vai receber a notificação.-
name *stringNome do usuario que vai receber a notificação.-
phone *objectObjeto contento informações do telefone do usuario que vai receber a notificação.Objeto phone
send_2_way *booleanoEnviar notificações de emissão de segunda via.true/false
send_after_due_date *booleanEnviar notificações após a data de vencimento do boleto.true/false
send_before_due_date *booleanEnviar notificações antes da data de vencimento do boleto.true/false
send_on_protest *booleanEnviar notificações de protesto.true/false

Objeto phone

CampoDescriçãoExemploMáx. Caracteres
country_codestringCódigo DDI do telefone (https://ddi.guiamais.com.br/)3
area_codestringCódigo DDD do telefone (https://ddd.guiamais.com.br/)2
numberstringNúmero de telefone (apenas números)10

Objeto discounts

CampoDescriçãoExemploMáx. Caracteres
discount_valuefloatValor do desconto.3
discount_numberint32Ordem que o desconto deve ser aplicado.2
discount_limit_datedateData limite do desconto.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

CampoTipoDescriçãoCaracteres
bank_slipslistLista com a informações dos boletos registrados caso o parâmetro use_multi_process seja informado com o valor false.Objeto Bank Slip
file_infolistInformações do arquivo, .Objeto File Info
occurrence_statsobjectInformações do arquivo, .Objeto File Info
semantic_errorslistLista de erros no processamento de cada boleto. Será retornado caso exista algum erro no processamento e caso o parâmetro use_multi_process seja informado com o valor false.Objeto Semantic Error

Objeto bank_slip

CampoTipoDescriçãoCaracteres
amountfloatValor do boleto.-
bank_slip_keyuuidChave unica de identificação do boleto na QI Tech.36
bank_slip_statusenumChave unica de identificação do boleto na QI Tech.Enumeradores bank_slip_status
barcodestringCódigo de barras do boleto.44
beneficiary_account_keyuuidChave unica de identificação da conta em que o boleto foi registrado.36
beneficiary_keyuuidChave unica de identificação do titular da conta em que o boleto foi registrado.36
digitable_lineuuidLinha digitável do boleto.47
expirationstringData de vencimento do boleto.10
nfe_keystringChave unica de identificação da nota fiscal eletrônica.-
nfe_urlstringURL da nota fiscal eletrônica.-
our_numberintNosso número bancário. É um número sequencial de identificação deste boleto em relação a conta (carteira de cobrança) em que ele foi registrado. Seu valor pode ser informado na requisição de registro do boleto. Caso não seja informado, a QI Tech gerará um valor deste campo (sendo este um valor incremental, ex: 1º boleto registrado na conta terá o our_number de valor 1, o 16º boleto registrado na conta terá o our_number de valor 16).-
participant_control_numberstringNúmero de controle do participante.10
payer_postal_codestringCEP do pagador do boleto.8
protest_statusstringSituação do protesto do boleto, caso o protesto tenha sido solicitado.Enumeradores protest_status
qr_codeobjectObjeto com as informações do QR Code Pix vinculado ao boleto.Objeto qr_code

Objeto qr_code

CampoTipoDescriçãoCaracteres
pix_keystringChave pix onde o QR Code Pix vinculado ao boleto foi registrado.100
qr_code_keyuuidChave única de identificação do QR Code Pix vinculado ao boleto .36
qr_code_urluuidURL do Pix Copia e Cola do QR Code Pix vinculado ao boleto.36

Enumeradores bank_slip_status

EnumeradorDescrição
acceptedBoleto aceito para processamento
registeredRegistro do boleto foi concluído na câmara de registro de boletos
paidValor do pagamento do boleto foi creditado na conta do beneficiário do boleto
written_offBoleto baixado (boleto não é mais pagável)
rejectedRegistro de boleto rejeitado pela câmara de registro de boletos
payment_noticeAviso de que o pagamento do boleto foi processado no banco pagador (porém a liquidação na conta do beneficiário ainda não ocorreu)
notary_office_payment_noticeAviso de que o pagamento de um boleto protestado foi processado no banco pagador (porém o cartório ainda não realizou o repasse do pagamento e a liquidação na conta do beneficiário ainda não ocorreu)

Enumeradores protest_status

EnumeradorDescrição
not_protestedBoleto não possui solicitação de protesto.
protest_requestedBoleto com solicitação de protesto em processamento pela QI Tech.
notary_office_entrySolicitação de protesto de boleto foi aceita pelo cartório.
protest_cancel_requestedSolicitação de cancelamento de protesto em processamento pela QI Tech.
notary_office_exitProtesto do boleto foi retirado do cartório.
protestedProtesto foi confirmado pelo cartório e o boleto se encontrada protestado.
paid_at_notary_officeCartório identificou o pagamento do protesto do boleto e esta processando o repasse do pagamento para a QI Tech.
judicially_suspendedProtesto suspenso judicialmente.
protest_remove_requestedSolicitação de retirada de protesto foi aceita pelo cartório.