Banco Inter · Schema

boletoResponse

CompanyBankingFintechPaymentsPixBrazilDigital BankOpen Banking

Properties

Name Type Description
nomeBeneficiario string Nome do beneficiário.
cnpjCpfBeneficiario string CNPJ do beneficiário.
tipoPessoaBeneficiario string Tipo do beneficiário.
contaCorrente string Conta corrente do boleto emitido
nossoNumero string Identificador único do boleto emitido.
seuNumero string Campo seuNumero do boleto emitido.
pagador object
motivoCancelamento string Motivo do Cancelamento.
situacao string Situacao do boleto.
dataHoraSituacao string Data referente à situação do boleto. Formato aceito: YYYY-MM-DD
dataVencimento string Data referente ao vencimento do boleto. Formato aceito: YYYY-MM-DD
valorNominal number Valor Nominal do boleto.
valorTotalRecebimento number Valor Total Recebimento.
dataEmissao string Data referente à emissão do boleto. Formato aceito: YYYY-MM-DD
dataLimite string Data referente ao limite de pagamento do boleto. Formato aceito: YYYY-MM-DD
codigoEspecie string Codigo de Espécie do boleto.
codigoBarras string Codigo de barras do boleto.
linhaDigitavel string Linha digitável do boleto.
origem string Origem da requisição que gerou o boleto.
mensagem object
desconto1 object
desconto2 object
desconto3 object
multa object
mora object
View JSON Schema on GitHub

JSON Schema

banco-inter-boleto-response-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/banco-inter/main/json-schema/banco-inter-boleto-response-schema.json",
  "title": "boletoResponse",
  "x-generated": "2026-10-18",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/banco-inter-cobranca-openapi.yml#/components/schemas/boletoResponse",
  "type": "object",
  "properties": {
    "nomeBeneficiario": {
      "type": "string",
      "description": "Nome do beneficiário.\n"
    },
    "cnpjCpfBeneficiario": {
      "type": "string",
      "description": "CNPJ do beneficiário.\n"
    },
    "tipoPessoaBeneficiario": {
      "type": "string",
      "description": "Tipo do beneficiário.\n"
    },
    "contaCorrente": {
      "type": "string",
      "description": "Conta corrente do boleto emitido\n"
    },
    "nossoNumero": {
      "type": "string",
      "description": "Identificador único do boleto emitido.\n"
    },
    "seuNumero": {
      "type": "string",
      "description": "Campo seuNumero do boleto emitido.\n"
    },
    "pagador": {
      "$ref": "#/$defs/pagador"
    },
    "motivoCancelamento": {
      "type": "string",
      "description": "Motivo do Cancelamento.\n"
    },
    "situacao": {
      "type": "string",
      "description": "Situacao do boleto.\n"
    },
    "dataHoraSituacao": {
      "type": "string",
      "description": "Data referente à situação do boleto.\nFormato aceito: YYYY-MM-DD\n"
    },
    "dataVencimento": {
      "type": "string",
      "description": "Data referente ao vencimento do boleto.\nFormato aceito: YYYY-MM-DD\n"
    },
    "valorNominal": {
      "type": "number",
      "description": "Valor Nominal do boleto.\n"
    },
    "valorTotalRecebimento": {
      "type": "number",
      "description": "Valor Total Recebimento.\n"
    },
    "dataEmissao": {
      "type": "string",
      "description": "Data referente à emissão do boleto.\nFormato aceito: YYYY-MM-DD\n"
    },
    "dataLimite": {
      "type": "string",
      "description": "Data referente ao limite de pagamento do boleto.\nFormato aceito: YYYY-MM-DD\n"
    },
    "codigoEspecie": {
      "type": "string",
      "description": "Codigo de Espécie do boleto.\n"
    },
    "codigoBarras": {
      "type": "string",
      "description": "Codigo de barras do boleto.\n"
    },
    "linhaDigitavel": {
      "type": "string",
      "description": "Linha digitável do boleto.\n"
    },
    "origem": {
      "type": "string",
      "description": "Origem da requisição que gerou o boleto.\n"
    },
    "mensagem": {
      "$ref": "#/$defs/mensagem"
    },
    "desconto1": {
      "$ref": "#/$defs/descontoResponse"
    },
    "desconto2": {
      "$ref": "#/$defs/descontoResponse"
    },
    "desconto3": {
      "$ref": "#/$defs/descontoResponse"
    },
    "multa": {
      "$ref": "#/$defs/multaResponse"
    },
    "mora": {
      "$ref": "#/$defs/moraResponse"
    }
  },
  "$defs": {
    "descontoResponse": {
      "properties": {
        "codigo": {
          "type": "string"
        },
        "data": {
          "type": "string"
        },
        "taxa": {
          "type": "number"
        },
        "valor": {
          "type": "number"
        }
      }
    },
    "mensagem": {
      "properties": {
        "linha1": {
          "type": "string",
          "description": "Linha 1 do campo de texto do título",
          "maxLength": 78
        },
        "linha2": {
          "type": "string",
          "description": "Linha 2 do campo de texto do título",
          "maxLength": 78
        },
        "linha3": {
          "type": "string",
          "description": "Linha 3 do campo de texto do título",
          "maxLength": 78
        },
        "linha4": {
          "type": "string",
          "description": "Linha 4 do campo de texto do título",
          "maxLength": 78
        },
        "linha5": {
          "type": "string",
          "description": "Linha 5 do campo de texto do título",
          "maxLength": 78
        }
      }
    },
    "moraResponse": {
      "properties": {
        "codigo": {
          "type": "string"
        },
        "data": {
          "type": "string"
        },
        "taxa": {
          "type": "number"
        },
        "valor": {
          "type": "number"
        }
      }
    },
    "multaResponse": {
      "properties": {
        "codigo": {
          "type": "string"
        },
        "data": {
          "type": "string"
        },
        "taxa": {
          "type": "number"
        },
        "valor": {
          "type": "number"
        }
      }
    },
    "pagador": {
      "type": "object",
      "required": [
        "cpfCnpj",
        "nome",
        "tipoPessoa",
        "cep",
        "endereco",
        "cidade",
        "uf"
      ],
      "properties": {
        "cpfCnpj": {
          "type": "string",
          "description": "CPF/CNPJ do pagador do título\n\nCNPJ: NNNNNNNNNFFFFCC\n\nCPF : 0000NNNNNNNNNCC,\n\nonde\n\n__NNNNNNNNN__ é a raiz do CNPJ/CPF\n\n__FFFF__ = filial do CNPJ\n\n__CC__ = dígitos de controle\n",
          "minLength": 11,
          "maxLength": 14
        },
        "tipoPessoa": {
          "type": "string",
          "description": "Tipo do pagador:\n* `FISICA` - Pessoa Física\n* `JURIDICA` - Pessoa Jurídica\n"
        },
        "nome": {
          "type": "string",
          "description": "Nome do pagador",
          "maxLength": 100,
          "minLength": 1
        },
        "endereco": {
          "type": "string",
          "description": "Endereço do pagador",
          "maxLength": 100,
          "minLength": 1
        },
        "numero": {
          "type": "string",
          "description": "Número no logradouro do pagador",
          "maxLength": 10,
          "default": ""
        },
        "complemento": {
          "type": "string",
          "description": "Complemento do endereço do pagador",
          "maxLength": 30,
          "default": ""
        },
        "bairro": {
          "type": "string",
          "description": "Bairro do pagador",
          "maxLength": 60,
          "default": ""
        },
        "cidade": {
          "type": "string",
          "description": "Cidade do pagador",
          "maxLength": 60,
          "minLength": 1
        },
        "uf": {
          "type": "string",
          "description": "UF do pagador",
          "minLength": 2,
          "maxLength": 2
        },
        "cep": {
          "type": "string",
          "description": "CEP do pagador",
          "minLength": 8,
          "maxLength": 8
        },
        "email": {
          "type": "string",
          "default": "",
          "description": "E-mail do pagador",
          "maxLength": 50
        },
        "ddd": {
          "type": "string",
          "default": "",
          "description": "DDD do telefone do pagador",
          "maxLength": 2
        },
        "telefone": {
          "type": "string",
          "default": "",
          "description": "Telefone do pagador",
          "maxLength": 9
        }
      }
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/banco-inter-boleto-response"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.