Banco Inter Token API

openapi: 3.2.0
info:
  title: Banco Inter Token API
  version: '1.0'
  description: 'Operations tagged Token across 3 of this provider''s published API definitions: partners-credito-imobiliario-token-yaml.yaml, banco-inter-partners-credito-imobiliario-token-openapi.yml, banco-inter-token-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://ce-partners.uatbi.com.br/oauth
  description: Servidor OAuth
- url: https://cdpj.partners.bancointer.com.br/oauth/v2
  description: Servidor OAuth Produção
- url: https://cdpj-sandbox.partners.uatinter.co/oauth/v2
  description: Servidor OAuth Sandbox
tags:
- name: Token
paths:
  /token:
    post:
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/TokenRequest'
      tags:
      - Token
      summary: Obter token oAuth
      description: A autenticação OAuth é a mais recente forma de autenticar os novos serviços disponibilizados pelo Inter. O Token gerado será necessário para consumir as APIs do Inter.
      operationId: Token
      responses:
        '200':
          $ref: '#/components/responses/TokenResponse'
        '403':
          $ref: '#/components/responses/AcessoNegado'
        '404':
          $ref: '#/components/responses/NaoEncontrado'
        '503':
          $ref: '#/components/responses/ServicoIndisponivel'
    servers:
    - url: https://ce-partners.uatbi.com.br/oauth
      description: Servidor OAuth
components:
  responses:
    NaoEncontrado:
      description: Recurso solicitado não foi encontrado.
    TokenResponse:
      description: Dados para serem utilizados na requisição
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/TokenResponse'
    ServicoIndisponivel:
      description: Serviço não está disponível no momento. Serviço solicitado pode estar em manutenção ou fora da janela de funcionamento.
    AcessoNegado:
      description: Requisição de participante autenticado que viola alguma regra de autorização.
    TokenResponse_2:
      description: Sucesso. Token emitido
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/TokenResponse'
    FormatoInvalido:
      description: Requisição com formato inválido.
  schemas:
    TokenResponse:
      type: object
      properties:
        access_token:
          type: string
          description: Token gerado para ser utilizado nas requisições do Inter via Bearer.
        token_type:
          type: string
          description: Tipo do token gerado.
        expires_in:
          type: number
          description: Tempo de uso do token até expirar.
        scope:
          type: string
          description: Para qual escopo foi gerado o token.
    TokenRequest:
      type: object
      properties:
        client_id:
          type: string
          description: Client Id obtido no detalhe da tela de aplicações no IB
        client_secret:
          type: string
          description: Client Secret obtido no detalhe da tela de aplicações no IB
        grant_type:
          type: string
          description: GrantType que utilizamos, o default é (client_credentials)
          default: client_credentials
        scope:
          description: "Escopos cadastrados na tela de aplicações.  OBS: No caso de precisar adicionar mais de um escopo, os escopos devem ser separados com espaço (ce-imp-api:read ce-imp-api:write)   \nEscopos disponíveis: \n* `ce-imp-api:read`\n* `ce-imp-api:write`\nexample: ce-imp-api:write"
          type: string
      required:
      - client_id
      - client_secret
      - grant_type
      - scope
    TokenRequest_2:
      type: object
      properties:
        client_id:
          type: string
          description: Client Id obtido no detalhe da tela de aplicações no IB
        client_secret:
          type: string
          description: Client Secret obtido no detalhe da tela de aplicações no IB
        grant_type:
          type: string
          description: GrantType que utilizamos, o default é (client_credentials)
          default: client_credentials
        scope:
          description: "Escopos cadastrados na tela de aplicações.\n\n\n**Onde encontrar os escopos:**<br>\nVocê encontra os escopos necessários para acesso na documentação \nespecífica de cada endpoint.<br>\n**Exemplo:**<br>\nO endpoint para Consultar extrato requer o escopo `extrato.read`,\nconforme indicado na imagem abaixo, retirada da documentação:\n\n\n<img src=\"/media/exemplo_escopo.png\"><br>\n\n**Múltiplos escopos:**<br>\nÉ possível solicitar múltiplos escopos simultaneamente, enviando-os\nem sequência separados por espaço.<br>\n**Exemplo:**<br>\nPara gerar um token com permissões de consulta para extrato, cobrança\ne Pix, utilize:<br>\nextrato.read boleto-cobranca.read pix.read\n"
          example: extrato.read
          type: string
      required:
      - client_id
      - client_secret
      - grant_type
      - scope
x-refined-from:
- partners-credito-imobiliario-token-yaml.yaml
- banco-inter-partners-credito-imobiliario-token-openapi.yml
- banco-inter-token-openapi.yml