Emissão de boleto via JSON

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"
        }
    ]
}

Atenção!

Caso os dados de endereço do pagador do boleto não sejam informados, não será possível realizar o protesto do boleto em caso de não pagamento.

Query params

Campo	Tipo	Descrição	Caracteres
use_multi_process	boolean	Indica 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

Campo	Tipo	Descrição	Caracteres
occurrences *	array of objects	Lista de ocorrências a serem processadas.	Objeto occurrences

Objeto occurrences

Campo	Tipo	Descrição	Caracteres
amount *	double	Valor do boleto.	-
automatic_bankruptcy_protest	boolean	Configuração de protesto automático.	-
bank_teller_instructions	string	Instruções ao caixa (Mensagem/Observações do boleto).	-
beneficiary_account_key	string	Chave da conta do beneficiário.	-
beneficiary_key	string	Chave do beneficiário.	-
days_to_bankruptcy_protest	int	Número de dias para envio automático de protesto falimentar.	-
document_number	string	Numero do documento.	-
expiration *	string	Data de vencimento.	-
fine_percentage	string	Porcentagem de multa	-
interest_daily_value	string	Valor de juros por dia em reais	-
occurrence_type *	string	Tipo de ocorrência.	-
payer_address	string	Endereço do pagador.	-
payer_document *	string	Documento do pagador (CPF ou CNPJ).	-
payer_name *	string	Nome do pagador.	-
payer_person_type *	string	Tipo de pessoa pagante.	-
payer_postal_code_root	string	Os cinco primeiros digitos do CEP.	-
payer_postal_code_suffix	string	Os três últimos dígitos do CEP.	-
printing_policy	string	Política de impressão do boleto	-
registration_institution_enumerator *	string	Será sempre qi_scd.	qi_scd
requester_profile *	string	Número da carteira.	02
requester_profile_code *	string	Có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".	-
notification	object	Número da carteira.	Objeto notification
discounts	object	Lista de objetos com informações de desconto.	Objeto discounts
guarantor_name	string	Nome do sacador avalista.	-
guarantor_document_root	string	Base do CNPJ do sacador avalista.	-
guarantor_document_subsidiary	string	Informação de CNPJ de matriz ou filial.	-
guarantor_document_digit	string	Dígito verificador do CNPJ.	-

Objeto notification

Campo	Tipo	Descrição	Caracteres
document_number *	string	Numero de documento do usuario que vai receber a notificação.	-
email *	string	Email do usuario que vai receber a notificação.	-
name *	string	Nome do usuario que vai receber a notificação.	-
phone *	object	Objeto contento informações do telefone do usuario que vai receber a notificação.	Objeto phone
send_2_way *	booleano	Enviar notificações de emissão de segunda via.	true/false
send_after_due_date *	boolean	Enviar notificações após a data de vencimento do boleto.	true/false
send_before_due_date *	boolean	Enviar notificações antes da data de vencimento do boleto.	true/false
send_on_protest *	boolean	Enviar notificações de protesto.	true/false

Objeto phone

Campo	Tipo	Descrição	Caracteres
country_code	string	Código DDI do telefone (https://ddi.guiamais.com.br/)	3
area_code	string	Código DDD do telefone (https://ddd.guiamais.com.br/)	2
number	string	Número de telefone (apenas números)	10

Objeto discounts

Campo	Tipo	Descrição	Caracteres
discount_value	float	Valor do desconto.	-
discount_number	int	Ordem que o desconto deve ser aplicado.	-
discount_limit_date	date	Data limite do aplicação 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"
    }
  ],
  "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\"}",
    "title": "Bad Request",
    "description": "Invalid request body.",
    "translation": "Corpo da requisição inválido.",
    "extra_fields": {},
    "code": "LEG000069"
}

Response Params

Campo	Tipo	Descrição	Caracteres
bank_slips	list	Lista com a informações dos boletos registrados caso o parâmetro use_multi_process seja informado com o valor false.	Objeto Bank Slip
file_info	list	Informações do arquivo, .	Objeto File Info
occurrence_stats	object	Informações do arquivo, .	Objeto File Info
semantic_errors	list	Lista 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

Campo	Tipo	Descrição	Caracteres
amount	float	Valor do boleto.	-
bank_slip_key	uuid	Chave unica de identificação do boleto na QI Tech.	36
bank_slip_status	enum	Chave unica de identificação do boleto na QI Tech.	Enumeradores bank_slip_status
barcode	string	Código de barras do boleto.	44
beneficiary_account_key	uuid	Chave unica de identificação da conta em que o boleto foi registrado.	36
beneficiary_key	uuid	Chave unica de identificação do titular da conta em que o boleto foi registrado.	36
digitable_line	uuid	Linha digitável do boleto.	47
expiration	string	Data de vencimento do boleto.	10
nfe_key	string	Chave unica de identificação da nota fiscal eletrônica.	-
nfe_url	string	URL da nota fiscal eletrônica.	-
our_number	int	Nosso 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_number	string	Número de controle do participante.	10
payer_postal_code	string	CEP do pagador do boleto.	8
protest_status	string	Situação do protesto do boleto, caso o protesto tenha sido solicitado.	Enumeradores protest_status

Enumeradores bank_slip_status

Enumerador	Descrição
accepted	Boleto aceito para processamento
registered	Registro do boleto foi concluído na câmara de registro de boletos
paid	Valor do pagamento do boleto foi creditado na conta do beneficiário do boleto
written_off	Boleto baixado (boleto não é mais pagável)
rejected	Registro de boleto rejeitado pela câmara de registro de boletos
payment_notice	Aviso 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_notice	Aviso 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

Enumerador	Descrição
not_protested	Boleto não possui solicitação de protesto.
protest_requested	Boleto com solicitação de protesto em processamento pela QI Tech.
notary_office_entry	Solicitação de protesto de boleto foi aceita pelo cartório.
protest_cancel_requested	Solicitação de cancelamento de protesto em processamento pela QI Tech.
notary_office_exit	Protesto do boleto foi retirado do cartório.
protested	Protesto foi confirmado pelo cartório e o boleto se encontrada protestado.
paid_at_notary_office	Cartório identificou o pagamento do protesto do boleto e esta processando o repasse do pagamento para a QI Tech.
judicially_suspended	Protesto suspenso judicialmente.
protest_remove_requested	Solicitação de retirada de protesto foi aceita pelo cartório.