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

Query params

Campo	Tipo	Descrição	Caracteres
use_multi_process	boolean	Indica se o processamento deve ser asíncrono.	true/false

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	Protesto automático.	-
bank_teller_instructions *	string	Instruções ao caixa.	-
beneficiary_account_key *	string	Chave da conta do beneficiário.	-
beneficiary_key *	string	Chave do beneficiário.	-
days_to_bankruptcy_protest *	int32	Número de identificação do boleto.	-
document_number *	string	Chave do beneficiário.	-
beneficiary_key *	string	Chave do beneficiário.	-
expiration *	string	Data de vencimento.	-
fine_percentage *	string	Porcentagem de multa	-
interest_daily_value *	string	Valor de juros por dia em real	-
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 dígitos finais do CEP.	-
printing_policy *	string	Política de impressão do boleto	-
registration_institution_enumerator *	string	Enumerador da instituição de registro do boleto.	-
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 *	array of objects	Número da carteira.	Objeto notification
discounts *	array of objects	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	Descrição	Exemplo	Máx. 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	Descrição	Exemplo	Máx. Caracteres
discount_value	float	Valor do desconto.	3
discount_number	int32	Ordem que o desconto deve ser aplicado.	2
discount_limit_date	date	Data 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\"}"
}