# JPMC-PDP Documentation from https://developer.payments.jpmorgan.com

# Request to Pay via QR Code API (Brazil)

```yaml
openapi: 3.0.0
info:
  title: API Pix
  version: 2.8.6
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
  contact:
    name: Suporte PIX BCB
    email: suporte.pix@bcb.gov.br
    url: https://www.bcb.gov.br/estabilidadefinanceira/pix
  description: "A API Pix padroniza serviços oferecidos pelo PSP recebedor no contexto do arranjo Pix, direcionando:\n- o gerenciamentos de cobranças, com e sem recorrências, em lotes ou não;\n- o acompanhamento dos Pix e suas devoluções;\n- as consultas.\n\nOs serviços expostos pelo PSP recebedor permitem ao usuário recebedor estabelecer integração\nde sua automação com os serviços Pix do PSP.\n\n# Evolução da API Pix\n\nA API Pix busca respeitar __[SemVer](https://semver.org/lang/pt-BR/)__. Nesse sentido,\nmudanças compatíveis não devem gerar nova versão _major_.\n\nA versão da API é composta por 4 elementos: _major_, _minor_, _patch_ e _release candidate_.\nA versão `v[x]`que consta no path da URL é o elemento _major_ da versão da API.\nA evolução da versão se dá seguinte forma:\n\n  - Major: alterações incompatíveis, com quebra de contrato (v1.0.0 → v2.0.0) \n  - Minor: alterações compatíveis, sem quebra de contrato (v1.1.0 → v1.2.0)\n  - Patch: bugfixes, esclarecimentos às especificações, sem alterações funcionais (v1.1.1 → v1.1.2)\n  - Release candidate: versões de pré-lançamento de qualquer patch futuro, minor ou major (v1.0.0-rc.1 → v1.0.0-rc.22)\n\nAlterações sem quebra de contrato e esclarecimentos às especificações podem ocorrer a qualquer momento.\nClientes devem estar preparados para lidar com essas mudanças sem quebrar.\n\nAs seguintes mudanças são esperadas e consideradas retrocompatíveis:\n\n- Adição de novos recursos na API Pix;\n- Adição de novos parâmetros opcionais;\n- Adição de novos campos em respostas da API Pix;\n- Alteração da ordem de campos;\n- Adição de novos elementos em enumerações.\n\n\n# Tratamento de erros\n\nA API Pix retorna códigos de status HTTP para indicar sucesso ou falhas das\nrequisições, são eles:\n- Códigos `2xx` indicam sucesso; \n- Códigos `4xx` indicam falhas causadas pelas\ninformações enviadas pelo cliente ou pelo estado atual das entidades e;\n- Códigos `5xx` indicam problemas no serviço no lado da API Pix.\n\nAs respostas de erro incluem no corpo detalhes do erro seguindo o\n_schema_ da [RFC 7807](https://tools.ietf.org/html/rfc7807).\n\nO campo `type` identifica o tipo de erro e na API Pix segue o padrão:\n\n`https://pix.bcb.gov.br/api/v2/error/<TipoErro>`\n\nO padrão acima listado, referente ao campo `type`, não consiste, necessariamente, em uma\nURL que apresentará uma página web válida, ou um endpoint válido, embora possa, futuramente,\nser exatamente o caso. O objetivo primário é apenas e tão somente identificar o tipo de erro.\n\nConvém reforçar que a API Pix contempla uma lista de produtos e respectivas funcionalidades ofertadas pelo PSP recebedor. \nCabe à relação contratual com cada usuário recebedor a concessão da totalidade ou de um subconjunto de acessos\nrelacionados aos produtos ofertados. Por exemplo, o usuário recebedor, ao acessar uma funcionalidade não contemplada \nno seu escopo contratual, receberá o erro geral `AcessoNegado` descrito na próxima seção.\n\nAbaixo estão listados os tipos de erro e possíveis violações da API Pix.\n\n## Gerais\n\nEsta seção reúne erros que poderiam ser retornados por quaisquer endpoints listados na API Pix.\n\n### `RequisicaoInvalida`\n\n  * __Significado__: Requisição inválida.\n  * __HTTP Status Code__: [400 Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1).\n\n### `AcessoNegado`\n\n  * __Significado__: Requisição de participante autenticado que viola alguma regra de autorização.\n  * __HTTP Status Code__: [403 Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3).\n\n### `NaoEncontrado`\n\n  * __Significado__: Entidade não encontrada.\n  * __HTTP Status Code__: [404 Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4).\n\n### `PermanentementeRemovido`\n\n  * __Significado__: Indica que a entidade existia, mas foi permanentemente removida.\n  * __HTTP Status Code__: [410 Gone](https://tools.ietf.org/html/rfc7231#section-6.5.9).\n\n### `ErroInternoDoServidor`\n\n  * __Significado__: Condição inesperada ao processar requisição.\n  * __HTTP Status Code__: [500 Internal Server Error](https://tools.ietf.org/html/rfc7231#section-6.6.1).\n\n### `ServicoIndisponivel`\n\n  * __Significado__: Serviço não está disponível no momento. Serviço solicitado pode estar em manutenção ou fora da janela de funcionamento.\n  * __HTTP Status Code__: [503 Service Unavailable](https://tools.ietf.org/html/rfc7231#section-6.6.4).\n\n### `IndisponibilidadePorTempoEsgotado`\n\n  * __Significado__: Indica que o serviço demorou além do esperado para retornar.\n  * __HTTP Status Code__: [504 Gateway Timeout](https://tools.ietf.org/html/rfc7231#section-6.6.5).\n\n## Tag Cob\n\nEsta seção reúne erros retornados pelos endpoints organizados sob a tag `Cob`.\nEsses erros indicam problemas no gerenciamento de uma cobrança para pagamento imediato.\n\n### `CobNaoEncontrado`\n\n* __Significado__: Cobrança não encontrada para o txid informado.\n* __HTTP Status Code__: [404](https://tools.ietf.org/html/rfc7231#section-6.5.4).\n* __endpoints__: `[GET|PATCH] /cob/{txid}`.\n\n### `CobOperacaoInvalida`\n\n* __Significado__: a requisição que busca alterar ou criar uma cobrança para pagamento imediato\nnão respeita o _schema_ ou está semanticamente errada.\n* __HTTP Status Code__: [400](https://tools.ietf.org/html/rfc7231#section-6.5.1).\n* __endpoints__: `[POST|PUT|PATCH] /cob/{txid}`.\n\n__Violações__ para os endpoints `PUT|PATCH /cob/{txid}`:\n  - O campo cob.calendario.`expiracao` é igual ou menor que `zero`.\n  - O campo cob.valor.`original` não respeita o _schema_.\n  - O campo cob.valor.`original` é `zero`.\n  - O objeto cob.`devedor` não respeita o _schema_.\n  - O campo cob.`chave` não respeita o _schema_.\n  - O campo cob.`chave` corresponde a uma conta que não pertence a este usuário recebedor.\n  - O campo `solicitacaoPagador` não respeita o _schema_.\n  - O objeto `infoAdicionais` não respeita o _schema_.\n  - O `location` referenciado por loc.`id` inexiste.\n  - O `location` referenciado por loc.`id` já está sendo utilizado por outra cobrança.\n  - O `location` referenciado por cob.loc.`id` apresenta tipo \"cobv\" (deveria ser \"cob\").\n\n__Violações__ específicas para o endpoint `PUT /cob/{txid}`:\n  - A cobrança já existe, não está no status ATIVA, e a presente requisição busca alterá-la.\n\n__Violações__ específicas para o endpoint `PATCH /cob/{txid}`:\n  - A cobrança não está ATIVA, e a presente requisição busca alterá-la.\n  - A cobrança está ATIVA, e a presente requisição propõe alterar\n  seu status para _REMOVIDA_PELO_USUARIO_RECEBEDOR_ juntamente com outras alterações\n  (não faz sentido remover uma cobrança ao mesmo tempo em que se realizam\n  alterações que não serão aproveitadas).\n  - o campo cob.`status` não respeita o _schema_.\n\n### `CobConsultaInvalida`\n\n* __Significado__: os parâmetros de consulta à lista de cobranças para pagamento imediato\nnão respeitam o _schema_ ou não fazem sentido semanticamente.\n* __HTTP Status Code__: [400](https://tools.ietf.org/html/rfc7231#section-6.5.1).\n* __endpoints__: `GET /cob` e `GET /cob/{txid}`.\n\n__Violações__ específicas para o endpoint `GET /cob`:\n  - algum dos parâmetros informados para a consulta não respeita o _schema_.\n  - o _timestamp_ representado pelo parâmetro `fim` é anterior ao timestamp\n  representado pelo parâmetro `inicio`.\n  - ambos os parâmetros `cpf` e `cnpj` estão preenchidos.\n  - o parâmetro paginacao.`paginaAtual` é negativo.\n  - o parâmetro paginacao.`itensPorPagina` é negativo.\n\n__Violações__ específicas para o endpoint `GET /cob/{txid}`:\n  - o parâmetro `revisao` corresponde a uma revisão inexistente para a cobrança\n  apontada pelo parâmetro `txid`.\n\n## Tag CobV\n\nEsta seção reúne erros retornados pelos endpoints organizados sob a tag `CobV`.\nEsses erros indicam problemas no gerenciamento de uma cobrança com vencimento.\n\n### `CobVNaoEncontrada`\n\n* __Significado__: Cobrança com vencimento não encontrada para o txid informado.\n* __HTTP Status Code__: [404](https://tools.ietf.org/html/rfc7231#section-6.5.4).\n* __endpoints__: `[GET|PATCH] /cobv/{txid}`.\n\n### `CobVOperacaoInvalida`\n\n* __Significado__: a requisição que busca alterar ou criar uma cobrança com vencimento\nnão respeita o _schema_ ou está semanticamente errada.\n* __HTTP Status Code__: [400](https://tools.ietf.org/html/rfc7231#section-6.5.1).\n* __endpoints__: `[PUT|PATCH] /cobv/{txid}`.\n\n__Violações__ para os endpoints `PUT|PATCH /cobv/{txid}`:\n  - Este `txid` está associado a um lote e no referido lote, o status desta cobrança está atribuído como\n  \"EM_PROCESSAMENTO\" ou \"NEGADA\".\n  - O campo cobv.calendario.`dataDeVencimento` é anterior à data de criação da cobrança.\n  - O campo cobv.calendario.`validadeAposVencimento` é menor do que zero.\n  - O objeto cobv.`devedor` não respeita o _schema_.\n  - O objeto cobv.`devedor` não respeita o _schema_.\n  - O campo cobv.`chave` não respeita o _schema_.\n  - O campo cobv.`chave` corresponde a uma conta que não pertence a este usuário recebedor.\n  - O campo `solicitacaoPagador` não respeita o _schema_.\n  - O objeto `infoAdicionais` não respeita o _schema_.\n  - O location referenciado por cobv.loc.`id` inexiste.\n  - O location referenciado por cobv.loc.`id` já está sendo utilizado por outra cobrança.\n  - O location referenciado por cobv.loc.`id` apresenta tipo \"cob\" (deveria ser \"cobv\").\n  - O campo cobv.valor.`original` não respeita o _schema_.\n  - O campo cobv.valor.`original` apresenta o valor `zero`.\n  - O objeto cobv.valor.`multa` não respeita o _schema_.\n  - O objeto cobv.valor.`juros` não respeita o _schema_.\n  - O objeto cobv.valor.`abatimento` não respeita o _schema_.\n  - O objeto cobv.valor.`desconto` não respeita o _schema_.\n  - O objeto cobv.valor.`abatimento` representa um valor maior ou igual ao valor da\n  cobrança original ou maior ou igual a 100%.\n  - O objeto cobv.valor.`desconto` apresenta algum elemento de desconto que representa um valor maior ou\n  igual ao valor da cobrança original ou maior ou igual a 100%.\n  - O objeto cobv.valor.`desconto` apresenta algum elemento cuja data seja posterior à data de vencimento\n  representada por calendario.`dataDeVencimento`.\n  - O objeto cobv.valor.`desconto` apresenta modalidade no valor `1` ou `2`,\n  porém cobv.valor.desconto.`valorPerc` encontra-se preenchido\n  - O objeto cobv.valor.`desconto` apresenta modalidade no valor `1` ou `2`, porém\n  o array cobv.valor.desconto.`descontoDataFixa` está vazio ou nulo.\n  - O objeto cobv.valor.`desconto` apresenta modalidade nos valores de `3` a `6`, porém\n  o elemento cobv.valor.desconto.`valorPerc` não está preenchido.\n  - O objeto cobv.valor.`desconto` apresenta modalidade nos valores de `3` a `6`, porém\n  o elemento cobv.valor.desconto.`descontoDataFixa` está preenchido ou não nulo.\n\n__Violações__ específicas para o endpoint `PUT /cobv/{txid}`:\n  - A cobrança já existe, não está ATIVA, e a presente requisição busca alterá-la\n\n__Violações__ específicas para o endpoint `PATCH /cobv/{txid}`:\n  - A cobrança não está ATIVA, e a presente requisição busca alterá-la\n  - A cobrança está ATIVA, e a presente requisição propõe alterar\n  seu status para _REMOVIDA_PELO_USUARIO_RECEBEDOR_ juntamente com outras alterações\n  (não faz sentido remover uma cobrança ao mesmo tempo em que se realizam\n  alterações que não serão aproveitadas).\n  - o campo cob.`status` não respeita o _schema_.\n\n### `CobVConsultaInvalida`\n\n* __Significado__: os parâmetros de consulta à lista de cobranças com vencimento não respeitam o schema\nou não fazem sentido semanticamente.\n* __HTTP Status Code__: [400](https://tools.ietf.org/html/rfc7231#section-6.5.1).\n* __endpoints__: `GET /cobv` e `GET /cobv/{txid}`.\n\n__Violações__ específicas para o endpoint `GET /cobv`:\n  - algum dos parâmetros informados para a consulta não respeita o _schema_.\n  - o _timestamp_ representado pelo parâmetro `fim` é anterior ao timestamp\n  representado pelo parâmetro `inicio`.\n  - ambos os parâmetros `cpf` e `cnpj` estão preenchidos.\n  - o parâmetro paginacao.`paginaAtual` é negativo.\n  - o parâmetro paginacao.`itensPorPagina` é negativo.\n\n__Violações__ específicas para o endpoint `GET /cobv/{txid}`:\n  - o parâmetro `revisao` corresponde a uma revisão inexistente para a cobrança\n  apontada pelo parâmetro `txid`.\n\n## Tag PayloadLocation\nEsta seção reúne erros referentes a endpoints que tratam do gerenciamento de _locations_.\n\n### `PayloadLocationNaoEncontrado`\n* __Significado__: _Location_ não encontrada para o `id` informado.\n* __HTTP Status Code__: [404](https://tools.ietf.org/html/rfc7231#section-6.5.4).\n* __endpoints__: `[GET|PATCH] /loc/{id}`, `DELETE /loc/{id}/txid`.\n\n### `PayloadLocationOperacaoInvalida`\n\n* __Significado__: a presente requisição busca criar uma location sem respeitar o _schema_ estabelecido.\n* __HTTP Status Code__: [400](https://tools.ietf.org/html/rfc7231#section-6.5.1).\n* __endpoints__: `POST /loc`.\n\n__Violações__ para o endpoint `POST /loc`:\n  - o campo `tipoCob` não respeita o _schema_.\n\n### `PayloadLocationConsultaInvalida`\n\n* __Significado__: os parâmetros de consulta à lista de _locations_ não respeitam\no _schema_ ou não fazem sentido semanticamente.\n* __HTTP Status Code__: [400](https://tools.ietf.org/html/rfc7231#section-6.5.1).\n* __endpoints__: `GET /loc` e `GET /loc/{id}`.\n\n__Violações__ específicas para o endpoint `GET /loc`:\n  - algum dos parâmetros informados para a consulta não respeitam o _schema_.\n  - o _timestamp_ representado pelo parâmetro `fim` é anterior ao timestamp\n  representado pelo parâmetro `inicio`.\n  - o parâmetro paginacao.`paginaAtual` é negativo.\n  - o parâmetro paginacao.`itensPorPagina` é negativo."
servers:
  - url: https://pix.payments.jpmorgan.com/rec/v2
    description: PRODUCTION - OAUTH
  - url: https://pix-h.payments.jpmorgan.com/rec/v2
    description: CLIENT TESTING - OAUTH
  - url: https://api-mock.payments.jpmorgan.com/rec/v2
    description: MOCK
tags:
  - name: Cob
    x-displayName: Gerenciamento de cobranças para pagamento imediato
    description: Reúne endpoints destinados a lidar com gerenciamento de cobranças imediatas.
  - name: CobV
    x-displayName: Gerenciamento de cobranças com vencimento
    description: Reúne endpoints destinados a lidar com gerenciamento de cobranças com vencimento.
  - name: PayloadLocation
    x-displayName: Configuração de locations para payloads
    description: Reúne endpoints destinados a lidar com configuração e remoção de locations para uso dos payloads
paths:
  /cob/{txid}:
    parameters:
      - $ref: '#/components/parameters/txid'
    put:
      operationId: updateImmediatePaymentRequest
      tags:
        - Cob
      summary: Criar cobrança imediata.
      description: Endpoint para criar uma cobrança imediata.
      requestBody:
        $ref: '#/components/requestBodies/CobBody'
      responses:
        '201':
          description: Cobrança imediata criada
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CobGerada'
              examples:
                retorno1:
                  $ref: '#/components/examples/cobResponse1'
                retorno2:
                  $ref: '#/components/examples/cobResponse5'
                retorno3:
                  $ref: '#/components/examples/cobResponse6'
                retorno4:
                  $ref: '#/components/examples/cobResponse7'
        '400':
          $ref: '#/components/responses/RequisicaoInvalidaCob'
        '403':
          $ref: '#/components/responses/AcessoNegado'
        '404':
          $ref: '#/components/responses/NaoEncontrado'
        '503':
          $ref: '#/components/responses/ServicoIndisponivel'
    patch:
      operationId: patchImmediatePaymentRequest
      tags:
        - Cob
      summary: Revisar cobrança imediata.
      requestBody:
        $ref: '#/components/requestBodies/CobBodyRevisada'
      responses:
        '200':
          description: Cobrança imediata revisada. A revisão deve ser incrementada em 1.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CobGerada'
              examples:
                retorno1:
                  $ref: '#/components/examples/cobResponse3'
        '400':
          $ref: '#/components/responses/RequisicaoInvalidaCob'
        '403':
          $ref: '#/components/responses/AcessoNegado'
        '404':
          $ref: '#/components/responses/NaoEncontrado'
        '503':
          $ref: '#/components/responses/ServicoIndisponivel'
    get:
      operationId: retrieveImmediatePaymentRequest
      parameters:
        - $ref: '#/components/parameters/revisao'
      tags:
        - Cob
      summary: Consultar cobrança imediata.
      description: Endpoint para consultar uma cobrança através de um determinado txid.
      responses:
        '200':
          description: Dados da cobrança imediata.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CobCompleta'
              examples:
                retorno1:
                  $ref: '#/components/examples/cobResponse1'
                retorno2:
                  $ref: '#/components/examples/cobResponse2'
                retorno3:
                  $ref: '#/components/examples/cobResponse5'
                retorno4:
                  $ref: '#/components/examples/cobResponse6'
                retorno5:
                  $ref: '#/components/examples/cobResponse7'
        '400':
          $ref: '#/components/responses/RequisicaoInvalidaCobGet'
        '403':
          $ref: '#/components/responses/AcessoNegado'
        '404':
          $ref: '#/components/responses/NaoEncontrado'
        '503':
          $ref: '#/components/responses/ServicoIndisponivel'
  /cob:
    post:
      operationId: generateImmediatePaymentRequest
      tags:
        - Cob
      summary: Criar cobrança imediata.
      description: Endpoint para criar uma cobrança imediata, neste caso, o txid deve ser definido pelo PSP.
      requestBody:
        $ref: '#/components/requestBodies/CobBody'
      responses:
        '201':
          description: Cobrança imediata criada
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CobGerada'
              examples:
                retorno1:
                  $ref: '#/components/examples/cobResponse1'
                retorno2:
                  $ref: '#/components/examples/cobResponse5'
                retorno3:
                  $ref: '#/components/examples/cobResponse6'
                retorno4:
                  $ref: '#/components/examples/cobResponse7'
        '400':
          $ref: '#/components/responses/RequisicaoInvalidaCob'
        '403':
          $ref: '#/components/responses/AcessoNegado'
        '503':
          $ref: '#/components/responses/ServicoIndisponivel'
    get:
      operationId: listImmediatePaymentRequest
      parameters:
        - $ref: '#/components/parameters/inicio'
        - $ref: '#/components/parameters/fim'
        - $ref: '#/components/parameters/locacaoPresente'
        - $ref: '#/components/parameters/status'
        - $ref: '#/components/parameters/paginaAtual'
        - $ref: '#/components/parameters/itensPorPagina'
      tags:
        - Cob
      summary: Consultar lista de cobranças imediatas.
      description: Endpoint para consultar cobranças imediatas através de parâmetros como início, fim, cpf, cnpj e status.
      responses:
        '200':
          description: Lista de cobranças imediatas.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CobsConsultadas'
              examples:
                getCobs1:
                  $ref: '#/components/examples/getCobs1'
                getCobs2:
                  $ref: '#/components/examples/getCobs2'
        '400':
          $ref: '#/components/responses/RequisicaoInvalidaCobList'
        '403':
          $ref: '#/components/responses/AcessoNegado'
        '503':
          $ref: '#/components/responses/ServicoIndisponivel'
  /cobv/{txid}:
    parameters:
      - $ref: '#/components/parameters/txid'
    put:
      operationId: updateDueDatePaymentRequest
      tags:
        - CobV
      summary: Criar cobrança com vencimento.
      description: Endpoint para criar uma cobrança com vencimento.
      requestBody:
        $ref: '#/components/requestBodies/CobVBody'
      responses:
        '201':
          description: Cobrança com vencimento criada
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CobVGerada'
              examples:
                retorno1:
                  $ref: '#/components/examples/cobResponse4'
        '400':
          $ref: '#/components/responses/RequisicaoInvalidaCobV'
        '403':
          $ref: '#/components/responses/AcessoNegado'
        '404':
          $ref: '#/components/responses/NaoEncontrado'
        '503':
          $ref: '#/components/responses/ServicoIndisponivel'
    patch:
      operationId: patchDueDatePaymentRequest
      tags:
        - CobV
      summary: Revisar cobrança com vencimento.
      requestBody:
        $ref: '#/components/requestBodies/CobVBodyRevisada'
      responses:
        '200':
          description: Cobrança com vencimento revisada. A revisão deve ser incrementada em 1.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CobVGerada'
              examples:
                retorno1:
                  $ref: '#/components/examples/cobResponse4'
        '400':
          $ref: '#/components/responses/RequisicaoInvalidaCob'
        '403':
          $ref: '#/components/responses/AcessoNegado'
        '404':
          $ref: '#/components/responses/NaoEncontrado'
        '503':
          $ref: '#/components/responses/ServicoIndisponivel'
    get:
      operationId: retrieveDueDatePaymentRequest
      parameters:
        - $ref: '#/components/parameters/revisao'
      tags:
        - CobV
      summary: Consultar cobrança com vencimento.
      description: Endpoint para consultar uma cobrança com vencimento através de um determinado txid.
      responses:
        '200':
          description: Dados da cobrança com vencimento.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CobVCompleta'
              examples:
                retorno1:
                  $ref: '#/components/examples/cobResponse4'
        '400':
          $ref: '#/components/responses/RequisicaoInvalidaCobVGet'
        '403':
          $ref: '#/components/responses/AcessoNegado'
        '404':
          $ref: '#/components/responses/NaoEncontrado'
        '503':
          $ref: '#/components/responses/ServicoIndisponivel'
  /cobv:
    get:
      operationId: listDueDatePaymentRequest
      parameters:
        - $ref: '#/components/parameters/inicio'
        - $ref: '#/components/parameters/fim'
        - $ref: '#/components/parameters/locacaoPresente'
        - $ref: '#/components/parameters/status'
        - $ref: '#/components/parameters/idLoteInteger'
        - $ref: '#/components/parameters/paginaAtual'
        - $ref: '#/components/parameters/itensPorPagina'
      tags:
        - CobV
      summary: Consultar lista de cobranças com vencimento.
      description: Endpoint para consultar cobranças com vencimento através de parâmetros como início, fim, cpf, cnpj e status.
      responses:
        '200':
          description: Lista de cobranças com vencimento.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CobsVConsultadas'
              examples:
                getCobs1:
                  $ref: '#/components/examples/getCobsV1'
        '400':
          $ref: '#/components/responses/RequisicaoInvalidaCobVList'
        '403':
          $ref: '#/components/responses/AcessoNegado'
        '503':
          $ref: '#/components/responses/ServicoIndisponivel'
  /loc:
    post:
      operationId: generatePaymentLink
      tags:
        - PayloadLocation
      summary: Criar location do payload.
      description: Criar location do payload
      requestBody:
        $ref: '#/components/requestBodies/PayloadLocationBody'
      responses:
        '201':
          description: Dados da location do Payload.
          headers:
            location:
              schema:
                type: string
                format: uri
                minLength: 0
                maxLength: 77
                title: Identificador da location criada.
                description: Identificador da location criada.
                example: https://pix.example.com/api/loc/1234567
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayloadLocation'
              examples:
                getPayloadLocation1:
                  $ref: '#/components/examples/payloadLocationResponse5'
                getPayloadLocation2:
                  $ref: '#/components/examples/payloadLocationResponse6'
        '400':
          $ref: '#/components/responses/RequisicaoInvalidaLocation'
        '403':
          $ref: '#/components/responses/AcessoNegado'
        '503':
          $ref: '#/components/responses/ServicoIndisponivel'
    get:
      operationId: listPaymentLink
      parameters:
        - $ref: '#/components/parameters/inicio'
        - $ref: '#/components/parameters/fim'
        - $ref: '#/components/parameters/txIdPresente'
        - $ref: '#/components/parameters/tipoCob'
        - $ref: '#/components/parameters/paginaAtual'
        - $ref: '#/components/parameters/itensPorPagina'
      tags:
        - PayloadLocation
      summary: Consultar locations cadastradas.
      description: Endpoint para consultar locations cadastradas
      responses:
        '200':
          description: lista dos locations cadastrados de acordo com o critério de busca.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayloadLocationConsultadas'
              examples:
                getPayloadLocations:
                  $ref: '#/components/examples/getPayloadLocation1'
        '400':
          $ref: '#/components/responses/RequisicaoInvalidaLocationList'
        '403':
          $ref: '#/components/responses/AcessoNegado'
        '503':
          $ref: '#/components/responses/ServicoIndisponivel'
  /loc/{id}:
    parameters:
      - $ref: '#/components/parameters/idLocation'
    get:
      operationId: retrievePaymentLink
      tags:
        - PayloadLocation
      summary: Recuperar location do payload.
      description: Recupera a location do payload
      responses:
        '200':
          description: Dados da location do Payload.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayloadLocationCompleta'
              examples:
                getPayloadLocation1:
                  $ref: '#/components/examples/payloadLocationResponse1'
                getPayloadLocation2:
                  $ref: '#/components/examples/payloadLocationResponse2'
                getPayloadLocation3:
                  $ref: '#/components/examples/payloadLocationResponse3'
        '400':
          $ref: '#/components/responses/RequisicaoInvalidaLocationGet'
        '403':
          $ref: '#/components/responses/AcessoNegado'
        '404':
          $ref: '#/components/responses/NaoEncontrado'
        '503':
          $ref: '#/components/responses/ServicoIndisponivel'
  /loc/{id}/txid:
    parameters:
      - $ref: '#/components/parameters/idLocation'
    delete:
      operationId: unlinkPaymentLink
      tags:
        - PayloadLocation
      summary: Desvincular uma cobrança de uma location.
      description: |
        Endpoint utilizado para desvincular uma cobrança de uma location.

        Se executado com sucesso, a entidade `loc` não apresentará mais um txid,
        se apresentava anteriormente à chamada. Adicionalmente, a entidade `cob` ou `cobv` associada ao
        txid desvinculado também passará a não mais apresentar um _location_. Esta operação
        não altera o `status` da `cob` ou `cobv` em questão.
      responses:
        '200':
          description: cobrança representada pelo txid informado desvinculada com sucesso.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayloadLocation'
              examples:
                getPayloadLocation1:
                  $ref: '#/components/examples/payloadLocationResponse4'
        '400':
          $ref: '#/components/responses/RequisicaoInvalidaLocationGet'
        '403':
          $ref: '#/components/responses/AcessoNegado'
        '404':
          $ref: '#/components/responses/NaoEncontrado'
        '503':
          $ref: '#/components/responses/ServicoIndisponivel'
components:
  x-jpmc-securitySchemes:
    MutualTLS:
      type: x509
      description: Mutual TLS authentication using client and server certificates.
  schemas:
    TxId:
      title: TxId
      type: string
      description: "Identificador da transação\n\nO campo `txid` determina o identificador da transação.\nO objetivo desse campo é ser um elemento que possibilite ao PSP do recebedor apresentar ao usuário recebedor a funcionalidade de conciliação de pagamentos.\n\nNa pacs.008, é referenciado como `TransactionIdentification <txId>` ou `idConciliacaoRecebedor`.\n\nEm termos de fluxo de funcionamento, o txid é lido pelo aplicativo do PSP do pagador e, \ndepois de confirmado o pagamento, é enviado para o SPI via pacs.008. \nUma pacs.008 também é enviada ao PSP do recebedor, contendo, além de todas as informações usuais \ndo pagamento, o txid.\nAo perceber um recebimento dotado de txid, o PSP do recebedor está apto a se comunicar com o usuário recebedor, \ninformando que um pagamento específico foi liquidado.\n\nO txid é criado exclusivamente pelo usuário recebedor e está sob sua responsabilidade.\nO txid, no contexto de representação de uma cobrança, é único por CPF/CNPJ do usuário recebedor. Cabe ao \nPSP recebedor validar essa regra na API Pix.\n"
      pattern: '[a-zA-Z0-9]{26,35}'
      minLength: 26
      maxLength: 35
    Revisao:
      title: Revisao
      type: integer
      format: int32
      description: |
        O campo `revisao`
        Denota a revisão da cobrança.  Sempre começa em zero. Sempre varia em acréscimos de 1.

        O incremento em uma cobrança deve ocorrer sempre que um objeto da cobrança em questão for alterado.
        O campo `loc` é uma exceção a esta regra.

        Se em uma determinada alteração em uma cobrança, o único campo alterado for o campo `loc`,
        então esta operação não incrementa a revisão da cobrança.

        O campo `loc` não ocasiona uma alteração na cobrança em si.
        Não é necessário armazenar histórico das alterações do campo `loc` para uma determinada cobrança.
        Para os outros campos da cobrança, registra-se histórico.
      minimum: 0
      maximum: 2147483647
    Criacao:
      title: Criacao
      description: Timestamp que indica o momento em que foi criada a cobrança. Respeita o formato definido na RFC 3339.
      type: string
      format: date-time
    Expiracao:
      title: Expiracao
      type: integer
      format: int32
      description: |
        Tempo de vida da cobrança, especificado em segundos a partir da data de criação (Calendario.criacao)
      example: 3600
      default: 86400
      minimum: 1
      maximum: 999999
    CalendarioCob:
      title: CalendarioCob
      required:
        - expiracao
      type: object
      description: Os campos aninhados sob o identificador calendário organizam informações a respeito de controle de tempo da cobrança.
      properties:
        criacao:
          $ref: '#/components/schemas/Criacao'
        expiracao:
          $ref: '#/components/schemas/Expiracao'
    CPF:
      title: CPF
      type: string
      pattern: ^\d{11}$
      description: CPF do usuário.
      minLength: 11
      maxLength: 11
    NomeUsuario:
      title: NomeUsuario
      type: string
      description: Nome do usuário.
      minLength: 1
      maxLength: 200
    PessoaFisica:
      title: PessoaFisica
      type: object
      description: Pessoa Física
      required:
        - cpf
        - nome
      properties:
        cpf:
          $ref: '#/components/schemas/CPF'
        nome:
          $ref: '#/components/schemas/NomeUsuario'
    CNPJ:
      title: CNPJ
      type: string
      pattern: ^\d{14}$
      description: CNPJ do usuário.
      minLength: 14
      maxLength: 14
    PessoaJuridica:
      title: PessoaJuridica
      type: object
      description: Pessoa Juridica
      required:
        - cnpj
        - nome
      properties:
        cnpj:
          $ref: '#/components/schemas/CNPJ'
        nome:
          $ref: '#/components/schemas/NomeUsuario'
    Devedor:
      title: Devedor
      type: object
      description: O objeto devedor organiza as informações sobre o devedor da cobrança.
      oneOf:
        - $ref: '#/components/schemas/PessoaFisica'
        - $ref: '#/components/schemas/PessoaJuridica'
    PayloadLocationId:
      title: PayloadLocationId
      type: integer
      format: int64
      description: Identificador da location a ser informada na criação da cobrança .
      minimum: 0
    TipoCob:
      title: TipoCob
      type: string
      description: Tipo da cobranca
      enum:
        - cob
        - cobv
    PayloadLocationCompleta:
      title: PayloadLocationCompleta
      type: object
      description: Identificador da localização do payload completo.
      required:
        - id
        - location
        - tipoCob
        - criacao
      properties:
        id:
          $ref: '#/components/schemas/PayloadLocationId'
        txid:
          $ref: '#/components/schemas/TxId'
        criacao:
          $ref: '#/components/schemas/Criacao'
        location:
          type: string
          title: Localizacao do payload
          description: Localização do Payload a ser informada na criação da cobrança.
          minLength: 0
          maxLength: 77
          format: uri
          example: https://pix.example.com/qr/v2/2353c790eefb11eaadc10242ac120002
          readOnly: true
        tipoCob:
          $ref: '#/components/schemas/TipoCob'
    CobrancaStatus:
      title: CobrancaStatus
      type: string
      description: |
        Estado do registro da cobrança. Não se confunde com o estado da cobrança em si, ou seja, não guarda relação com o fato de a cobrança encontrar-se vencida ou expirada, por exemplo.

        Os status são assim definidos:
        - `ATIVA`: indica que o registro se refere a uma cobrança que foi gerada mas ainda não foi paga nem removida;
        - `CONCLUIDA`: indica que o registro se refere a uma cobrança que já foi paga e, por conseguinte, não pode acolher outro pagamento;
        - `REMOVIDO_PELO_USUARIO_RECEBEDOR`: indica que o usuário recebedor solicitou a remoção do registro da cobrança; e
        - `REMOVIDO_PELO_PSP`: indica que o PSP Recebedor solicitou a remoção do registro da cobrança.
      enum:
        - ATIVA
        - CONCLUIDA
        - REMOVIDA_PELO_USUARIO_RECEBEDOR
        - REMOVIDA_PELO_PSP
    Valor:
      title: Valor
      type: string
      pattern: \d{1,10}\.\d{2}
      minLength: 4
      maxLength: 13
      description: Valor
    Saque:
      title: Saque
      description: Saque
      type: object
      properties:
        saque:
          type: object
          title: SaqueSaque
          description: Saque
          required:
            - valor
            - modalidadeAgente
            - prestadorDoServicoDeSaque
          properties:
            valor:
              $ref: '#/components/schemas/Valor'
            modalidadeAlteracao:
              type: integer
              format: int32
              minimum: 0
              maximum: 1
              default: 0
              title: Modalidade de alteracao do saque
              description: Modalidade de alteração de valor do saque. Quando não preenchido o valor assumido é o 0 (zero).
            modalidadeAgente:
              type: string
              title: Modalidade do Agente
              description: |
                ##### Modalidade do Agente
                <table><tr><th>SIGLA</th><th>Descrição</th></tr><tr><td>AGTEC</td><td>Agente Estabelecimento Comercial</td></tr><tr><td>AGTOT</td><td>Agente Outra Espécie de Pessoa Jurídica ou Correspondente no País</td></tr><tr><td>AGPSS</td><td>Agente Facilitador de Serviço de Saque (<b>ATENÇÃO</b>: no mapeamento para o campo 'modalidadeAgente', da pacs.008, esse valor deve ser substituído por <b>AGFSS</b>)</td></tr></table>
              enum:
                - AGTEC
                - AGTOT
                - AGPSS
            prestadorDoServicoDeSaque:
              type: string
              title: Facilitador de Servico de Saque
              pattern: \d{8}
              minLength: 8
              maxLength: 8
              description: ISPB do Facilitador de Serviço de Saque
      additionalProperties: false
    Troco:
      title: Troco
      description: Troco
      type: object
      properties:
        troco:
          type: object
          title: TrocoTroco
          description: Troco
          required:
            - valor
            - modalidadeAgente
            - prestadorDoServicoDeSaque
          properties:
            valor:
              $ref: '#/components/schemas/Valor'
            modalidadeAlteracao:
              type: integer
              format: int32
              minimum: 0
              maximum: 1
              default: 0
              title: Modalidade de alteracao do troco
              description: Modalidade de alteração de valor do troco. Quando não preenchido o valor assumido é o 0 (zero).
            modalidadeAgente:
              type: string
              title: Modalidade do Agente
              description: |
                ##### Modalidade do Agente
                <table><tr><th>SIGLA</th><th>Descrição</th></tr><tr><td>AGTEC</td><td>Agente Estabelecimento Comercial</td></tr><tr><td>AGTOT</td><td>Agente Outra Espécie de Pessoa Jurídica ou Correspondente no País</td></tr></table>
              enum:
                - AGTEC
                - AGTOT
            prestadorDoServicoDeSaque:
              type: string
              title: Facilitador de Servico de Saque
              pattern: \d{8}
              minLength: 8
              maxLength: 8
              description: ISPB do Facilitador de Serviço de Saque
      additionalProperties: false
    Retirada:
      title: Retirada
      description: É uma estrutura opcional relacionada ao conceito de recebimento de numerário. Apenas um agrupamento por vez é permitido, quando há `saque` não há `troco` e vice-versa.
      type: object
      oneOf:
        - $ref: '#/components/schemas/Saque'
        - $ref: '#/components/schemas/Troco'
    CobValorMandatorio:
      title: CobValorMandatorio
      description: valores monetários referentes à cobrança.
      type: object
      required:
        - original
      properties:
        original:
          $ref: '#/components/schemas/Valor'
        modalidadeAlteracao:
          type: integer
          format: int32
          minimum: 0
          maximum: 1
          title: Modalidade de alteracao
          description: Trata-se de um campo que determina se o valor final do documento pode ser alterado pelo pagador. Na ausência desse campo, assume-se que não se pode alterar o valor do documento de cobrança, ou seja, assume-se o valor 0. Se o campo estiver presente e com valor 1, então está determinado que o valor final da cobrança pode ter seu valor alterado pelo pagador.
        retirada:
          $ref: '#/components/schemas/Retirada'
    PixCopiaECola:
      title: PixCopiaECola
      type: string
      description: Este campo retorna o valor do Pix Copia e Cola correspondente à cobrança. Trata-se da sequência de caracteres que representa o BR Code.
      minLength: 0
      maxLength: 512
    Chave:
      title: Chave
      description: |
        Formato do campo chave

        * O campo chave determina a chave Pix registrada no DICT que será utilizada para a cobrança. Essa chave será lida pelo aplicativo do PSP do pagador para consulta ao DICT, que retornará a informação que identificará o recebedor da cobrança.
        * Os tipos de chave podem ser: telefone, e-mail, cpf/cnpj ou EVP.
        * O formato das chaves pode ser encontrado na seção "Formatação das chaves do DICT no BR Code" do [Manual de Padrões para iniciação do Pix](https://www.bcb.gov.br/estabilidadefinanceira/pix).
      type: string
      minLength: 0
      maxLength: 77
    SolicitacaoPagador:
      title: SolicitacaoPagador
      type: string
      description: O campo solicitacaoPagador, opcional, determina um texto a ser apresentado ao pagador para que ele possa digitar uma informação correlata, em formato livre, a ser enviada ao recebedor. Esse texto será preenchido, na pacs.008, pelo PSP do pagador, no campo RemittanceInformation <RmtInf>. O tamanho do campo <RmtInf> na pacs.008 está limitado a 140 caracteres.
      minLength: 0
      maxLength: 140
    InfoAdicional:
      title: InfoAdicional
      description: Informacao Adicional
      type: object
      required:
        - nome
        - valor
      properties:
        nome:
          type: string
          title: Nome
          description: Nome do campo.
          minLength: 1
          maxLength: 50
        valor:
          type: string
          title: Valor
          description: Dados do campo.
          minLength: 1
          maxLength: 200
    EndToEndId:
      title: EndToEndId
      type: string
      description: EndToEndIdentification que transita na PACS002, PACS004 e PACS008
      pattern: '[a-zA-Z0-9]{32}'
      minLength: 32
      maxLength: 32
    PixValorOriginal:
      title: PixValorOriginal
      type: object
      description: Valor original do Pix.
      properties:
        original:
          type: object
          title: ValorOriginal
          description: Objeto que representa o valor original de uma cobrança Pix.
          required:
            - valor
          properties:
            valor:
              $ref: '#/components/schemas/Valor'
    PixValorSaque:
      title: PixValorSaque
      description: Valor do Saque Pix.
      type: object
      properties:
        saque:
          type: object
          title: ValorSaque
          description: Objeto que representa o valor do saque em uma cobrança Pix.
          required:
            - valor
            - modalidadeAgente
            - prestadorDoServicoDeSaque
          properties:
            valor:
              $ref: '#/components/schemas/Valor'
            modalidadeAgente:
              type: string
              title: Modalidade do Agente
              description: |
                ##### Modalidade do Agente
                <table><tr><th>SIGLA</th><th>Descrição</th></tr><tr><td>AGTEC</td><td>Agente Estabelecimento Comercial</td></tr><tr><td>AGTOT</td><td>Agente Outra Espécie de Pessoa Jurídica ou Correspondente no País</td></tr><tr><td>AGPSS</td><td>Agente Facilitador de Serviço de Saque (<b>ATENÇÃO</b>: no mapeamento para o campo 'modalidadeAgente', da pacs.008, esse valor deve ser substituído por <b>AGFSS</b>)</td></tr></table>
              enum:
                - AGTEC
                - AGTOT
                - AGPSS
            prestadorDoServicoDeSaque:
              type: string
              title: Facilitador de Servico de Saque
              pattern: \d{8}
              minLength: 8
              maxLength: 8
              description: ISPB do Facilitador de Serviço de Saque
    PixValorTroco:
      title: PixValorTroco
      type: object
      description: Valor do Troco Pix.
      properties:
        troco:
          type: object
          title: ValorTroco
          description: Objeto que representa o valor do troco a ser aplicado em uma cobrança Pix.
          required:
            - valor
            - modalidadeAgente
            - prestadorDoServicoDeSaque
          properties:
            valor:
              $ref: '#/components/schemas/Valor'
            modalidadeAgente:
              type: string
              title: Modalidade do Agente
              description: |
                ##### Modalidade do Agente
                <table><tr><th>SIGLA</th><th>Descrição</th></tr><tr><td>AGTEC</td><td>Agente Estabelecimento Comercial</td></tr><tr><td>AGTOT</td><td>Agente Outra Espécie de Pessoa Jurídica ou Correspondente no País</td></tr></table>
              enum:
                - AGTEC
                - AGTOT
            prestadorDoServicoDeSaque:
              type: string
              title: Facilitador de Servico de Saque
              pattern: \d{8}
              minLength: 8
              maxLength: 8
              description: ISPB do Facilitador de Serviço de Saque
    PixValorJuros:
      title: PixValorJuros
      type: object
      description: Valor dos juros.
      properties:
        juros:
          type: object
          title: ValorJuros
          description: Objeto que representa o valor dos juros.
          required:
            - valor
          properties:
            valor:
              $ref: '#/components/schemas/Valor'
    PixValorMulta:
      title: PixValorMulta
      type: object
      description: Objeto que representa o valor da multa a ser aplicado em uma cobrança Pix.
      properties:
        multa:
          type: object
          title: ValorMulta
          description: Objeto que representa o valor da multa a ser aplicado em uma cobrança Pix.
          required:
            - valor
          properties:
            valor:
              $ref: '#/components/schemas/Valor'
    PixValorAbatimento:
      title: PixValorAbatimento
      type: object
      description: Valor do abatimento.
      properties:
        abatimento:
          type: object
          title: ValorAbatimento
          description: Objeto que representa o valor do abatimento a ser aplicado em uma cobrança Pix.
          required:
            - valor
          properties:
            valor:
              $ref: '#/components/schemas/Valor'
    PixValorDesconto:
      title: PixValorDesconto
      type: object
      description: Valor do desconto.
      properties:
        desconto:
          type: object
          title: ValorDesconto
          description: Objeto que representa o valor do desconto a ser aplicado em uma cobrança Pix.
          required:
            - valor
          properties:
            valor:
              $ref: '#/components/schemas/Valor'
    DevolucaoId:
      title: DevolucaoId
      type: string
      description: Id gerado pelo cliente para representar unicamente uma devolução.
      pattern: '[a-zA-Z0-9]{1,35}'
      minLength: 1
      maxLength: 35
    DevolucaoNatureza:
      title: DevolucaoNatureza
      type: string
      description: "Indica qual é a natureza da devolução. Uma devolução pode ser relacionada a um Pix comum (com códigos possíveis: `MD06`, `BE08` e `FR01` da pacs.004 e `REFU` da pacs.008), \nou a um Pix de Saque ou Troco (com códigos possíveis:  `MD06` e `SL02` da pacs.004). Na ausência deste campo a natureza deve ser interpretada como \nsendo de um Pix comum (`ORIGINAL`).\n\nAs naturezas são assim definidas:\n  - `ORIGINAL`: quando a devolução é solicitada pelo usuário recebedor e se refere a um Pix comum ou ao valor da compra em um Pix Troco (`MD06`);\n  - `RETIRADA`: quando a devolução é solicitada pelo usuário recebedor e se refere a um Pix Saque ou ao valor do troco em um Pix Troco (`SL02`);\n  - `MED_OPERACIONAL`: quando a devolução ocorre no âmbito do MED por motivo de falha operacional e se refere a um Pix comum (`BE08`);\n  - `MED_FRAUDE`: quando a devolução ocorre no âmbito do MED por fundada suspeita de fraude e se refere a um Pix comum (`FR01`).\n  - `MED_PIX_AUTOMATICO`: reembolso total ou parcial ao participante do usuário pagador no âmbito do MED (Mecanismo Especial de Devolução) para o Pix Automático pela utilização de recursos próprios para ressarcimento do usuário pagador.(`REFU`);\n\nOs valores de devoluções são sempre limitados aos valores máximos a seguir:\n- Pix comum: o valor da devolução é limitado ao valor do próprio Pix (a natureza nesse caso pode ser: ORIGINAL, MED_OPERACIONAL ou MED_FRAUDE);\n- Pix Saque: o valor da devolução é limitado ao valor da retirada (a natureza nesse caso deve ser: RETIRADA); e\n- Pix Troco: o valor da devolução é limitado ao valor relativo à compra ou ao troco:\n  - Quando a devolução for referente à compra, o valor limita-se ao valor da compra (a natureza nesse caso deve ser ORIGINAL); e\n  - Quando a devolução for referente ao troco, o valor limita-se ao valor do troco (a natureza nesse caso deve ser RETIRADA).\n"
      enum:
        - ORIGINAL
        - RETIRADA
        - MED_OPERACIONAL
        - MED_FRAUDE
        - MED_PIX_AUTOMATICO
    Horario:
      title: Horario
      type: object
      description: Horario da interacao no PSP
      properties:
        solicitacao:
          type: string
          format: date-time
          title: Horario de solicitacao
          description: Horário no qual a devolução foi solicitada no PSP.
        liquidacao:
          type: string
          format: date-time
          title: Horario de liquidacao
          description: Horário no qual a devolução foi liquidada no PSP.
    Devolucao:
      title: Devolucao
      description: Devolucao
      type: object
      required:
        - id
        - rtrId
        - valor
        - horario
        - status
      properties:
        id:
          $ref: '#/components/schemas/DevolucaoId'
        rtrId:
          type: string
          title: RtrId
          description: ReturnIdentification que transita na PACS004.
          example: D12345678202009091000abcde123456
          pattern: '[a-zA-Z0-9]{32}'
          minLength: 32
          maxLength: 32
        valor:
          $ref: '#/components/schemas/Valor'
        natureza:
          $ref: '#/components/schemas/DevolucaoNatureza'
        descricao:
          type: string
          title: Mensagem ao pagador relativa a devolucao.
          minLength: 0
          maxLength: 140
          description: O campo `descricao`, opcional, determina um texto a ser apresentado ao pagador contendo informações sobre a devolução. Esse texto será preenchido, na pacs.004, pelo PSP do recebedor, no campo RemittanceInformation. O tamanho do campo na pacs.004 está limitado a 140 caracteres.
        horario:
          $ref: '#/components/schemas/Horario'
        status:
          type: string
          title: Status
          description: Status da devolução.
          enum:
            - EM_PROCESSAMENTO
            - DEVOLVIDO
            - NAO_REALIZADO
        motivo:
          type: string
          title: Descricao do status.
          description: |
            Status da Devolução

            Campo opcional que pode ser utilizado pelo PSP recebedor para detalhar os motivos
            de a devolução ter atingido o status em questão.
            Pode ser utilizado, por exemplo, para detalhar o motivo de a devolução não ter sido realizada.
          minLength: 0
          maxLength: 140
    Pix:
      title: Pix
      type: object
      required:
        - endToEndId
        - valor
        - horario
      properties:
        endToEndId:
          $ref: '#/components/schemas/EndToEndId'
        txid:
          type: string
          pattern: '[a-zA-Z0-9]{1,35}'
          minLength: 1
          maxLength: 35
        valor:
          $ref: '#/components/schemas/Valor'
        componentesValor:
          type: object
          title: ComponentesValor
          description: "O objetivo dessa estrutura é explicar os elementos de composição do valor do Pix, incluindo informações sobre as multas, juros, descontos e abatimentos quando o Pix for relativo a cobranças com vencimento.\n\nRegras da estrutura:\n- O `valor` do Pix é igual a: \n  - (original.`valor` + saque.`valor` + troco.`valor`) + multa.`valor` + juros.`valor` – abatimento.`valor` – desconto.`valor`\n  considerando-se apenas os campos que estiverem presentes para cada tipo de cobrança pago.\n- As estruturas `saque` e `troco` só serão retornadas quando o Pix for relativo a um Pix Saque ou Pix Troco, respectivamente, e \nas demais estruturas (`juros`, `multa`, `abatimento` e `desconto`) só serão pertinentes aos Pix de pagamentos das cobranças com vencimento.\n- Não pode haver simultaneamente uma subsestrutura do tipo `saque` e outra do tipo `troco`;\n- Não há restrição na ordem das subestruturas.\n\nPara o caso de um Pix Saque pode-se retornar `original` com valor=0.00 (zero) uma vez que a soma será respeitada, ou pode-se omitir a \nsubestrutura original. No caso de um Pix Troco ou de um pagamento de cobrança com vencimento a subsestrutura `original` vai sempre estar \npresente.\n\n#### Exemplos válidos:\nExemplo de preenchimentos válidos. \n\n- **Pix para pagamento de cobrança imediata (sem saque ou troco).**\n  ```\n  ...\n  \"componentesValor\": {\n    \"original\": {\n      \"valor\": \"100.00\"\n    } \n  }\n  ...\n  ```\n- **Pix Saque.**\n  ```\n  ...\n  \"componentesValor\": {\n    \"saque\": {\n      \"valor\": \"100.00\",\n      \"modalidadeAgente\": \"AGPSS\",\n      \"prestadorDeServicoDeSaque\": \"12345678\"\n    } \n  }\n  ...\n  ```\n- **Pix para pagamento de cobrança imediata com saque (pode vir original.valor=0.00).**\n  ```\n  ...\n  \"componentesValor\": {\n    \"original\": {\n      \"valor\": \"0.00\"\n    },\n    \"saque\": {\n      \"valor\": \"100.00\",\n      \"modalidadeAgente\": \"AGPSS\",\n      \"prestadorDeServicoDeSaque\": \"12345678\"\n    } \n  }\n  ...\n  ```\n- **Pix Troco.**\n  ```\n  ...\n  \"componentesValor\": {\n    \"original\": {\n      \"valor\": \"80.00\"\n    },\n    \"troco\": {\n      \"valor\": \"20.00\",\n      \"modalidadeAgente\": \"AGTEC\",\n      \"prestadorDeServicoDeSaque\": \"12345678\"\n    } \n  }\n  ...\n  ```\n- **Pix para pagamento de cobrança imediata com troco (ordem não importa).**\n  ```\n  ...\n  \"componentesValor\": {\n    \"troco\": {\n      \"valor\": \"20.00\",\n      \"modalidadeAgente\": \"AGTEC\",\n      \"prestadorDeServicoDeSaque\": \"12345678\"\n    },\n    \"original\": {\n      \"valor\": \"80.00\"\n    }\n  }\n  ...\n  ```\n- **Pix para pagamento de cobrança com vencimento de R$100,00 considerando-se um atraso de 2 dias a uma multa de 3% e juros de 1% ao dia. O `valor` do Pix será R$105,00.**\n  ```\n  ...\n  \"componentesValor\": {\n    \"original\": {\n      \"valor\": \"100.00\"\n    },\n    \"multa\": {\n      \"valor\": \"3.00\"\n    },\n    \"juros\": {\n      \"valor\": \"2.00\"\n    }\n  }\n  ...\n  ```            \n#### Exemplos inválidos:\nExemplos, não exaustivos, de preenchimentos inválidos.\n- **original.`valor` maior que 0.00 (zero) e `saque` juntos**\n  ```\n  ...\n  \"componentesValor\": {\n    \"original\": {\n      \"valor\": \"80.00\"\n    },\n    \"saque\": {\n      \"valor\": \"20.00\",\n      \"modalidadeAgente\": \"AGPSS\",\n      \"prestadorDeServicoDeSaque\": \"12345678\"\n    } \n  }\n  ...\n  ```\n- **dois elementos de `saque`**\n  ```\n  ...\n  \"componentesValor\": [\n    \"saque\": {\n      \"valor\": \"20.00\",\n      \"modalidadeAgente\": \"AGPSS\",\n      \"prestadorDeServicoDeSaque\": \"12345678\"\n    },\n    \"saque\": {\n      \"valor\": \"10.00\",\n      \"modalidadeAgente\": \"AGPSS\",\n      \"prestadorDeServicoDeSaque\": \"12345678\"\n    } \n  ]\n  ...\n  ```\n- **saque e troco simultaneamente**\n  ```\n  ...\n  \"componentesValor\": {\n    \"original\": {\n      \"valor\": \"60.00\"\n    },\n    \"saque\": {\n      \"valor\": \"20.00\",\n      \"modalidadeAgente\": \"AGPSS\",\n      \"prestadorDeServicoDeSaque\": \"12345678\"\n    },\n    \"troco\": {\n      \"valor\": \"20.00\",\n      \"modalidadeAgente\": \"AGTEC\",\n      \"prestadorDeServicoDeSaque\": \"12345678\"\n    } \n  }\n  ...\n  ```"
          anyOf:
            - $ref: '#/components/schemas/PixValorOriginal'
            - $ref: '#/components/schemas/PixValorSaque'
            - $ref: '#/components/schemas/PixValorTroco'
            - $ref: '#/components/schemas/PixValorJuros'
            - $ref: '#/components/schemas/PixValorMulta'
            - $ref: '#/components/schemas/PixValorAbatimento'
            - $ref: '#/components/schemas/PixValorDesconto'
        chave:
          $ref: '#/components/schemas/Chave'
        horario:
          type: string
          format: date-time
          title: Horario
          description: Horário em que o Pix foi processado no PSP.
        infoPagador:
          type: string
          title: Informacao livre do pagador
          minLength: 0
          maxLength: 140
        devolucoes:
          type: array
          minItems: 0
          maxItems: 99
          title: Devolucoes
          items:
            $ref: '#/components/schemas/Devolucao'
    CobCompleta:
      title: CobCompleta
      type: object
      description: Cobranca imediata completa
      required:
        - txid
        - calendario
        - revisao
        - status
        - valor
        - chave
      properties:
        calendario:
          $ref: '#/components/schemas/CalendarioCob'
        txid:
          $ref: '#/components/schemas/TxId'
        revisao:
          $ref: '#/components/schemas/Revisao'
        devedor:
          $ref: '#/components/schemas/Devedor'
        loc:
          type: object
          description: Localizacao do payload a ser informada na criacao da cobranca.
          required:
            - id
            - tipoCob
            - criacao
          allOf:
            - $ref: '#/components/schemas/PayloadLocationCompleta'
        location:
          type: string
          title: Localizacao do payload
          description: Localização do Payload a ser informada na criação da cobrança.
          minLength: 0
          maxLength: 77
          format: uri
          example: https://pix.example.com/qr/v2/2353c790eefb11eaadc10242ac120002
          readOnly: true
        status:
          $ref: '#/components/schemas/CobrancaStatus'
        valor:
          $ref: '#/components/schemas/CobValorMandatorio'
        pixCopiaECola:
          $ref: '#/components/schemas/PixCopiaECola'
        chave:
          $ref: '#/components/schemas/Chave'
        solicitacaoPagador:
          $ref: '#/components/schemas/SolicitacaoPagador'
        infoAdicionais:
          type: array
          title: InfoAdicionais
          description: Cada respectiva informação adicional contida na lista (nome e valor) deve ser apresentada ao pagador.
          minItems: 0
          maxItems: 50
          items:
            $ref: '#/components/schemas/InfoAdicional'
        pix:
          type: array
          title: PixRecebidos
          minItems: 0
          maxItems: 25
          items:
            type: object
            title: PixRecebido
            allOf:
              - $ref: '#/components/schemas/Pix'
              - type: object
                properties:
                  txid:
                    $ref: '#/components/schemas/TxId'
    Violacao:
      title: Violacao
      description: |
        # Violação
        A violação é um objeto que representa uma violação de regra de negócio ou validação de dados.
        Ele é utilizado para descrever o motivo pelo qual uma solicitação não pôde ser processada corretamente.
        Cada violação contém informações sobre a propriedade afetada, o valor da propriedade e uma descrição do erro.
      type: object
      properties:
        razao:
          type: string
          title: Descricao do erro
          description: Descrição do erro
          example: Valor da cobrança não pode ser 0.00
          minLength: 0
          maxLength: 99
        propriedade:
          type: string
          title: Nome da propriedade
          description: Nome da propriedade
          example: cob.chave
          minLength: 0
          maxLength: 99
        valor:
          type: string
          title: Valor da propriedade
          description: Valor da propriedade
          example: '061996671234'
          minLength: 0
          maxLength: 99
    Problema:
      title: Problema
      type: object
      required:
        - type
        - title
        - status
      properties:
        type:
          type: string
          format: uri
          description: URI de referência que identifica o tipo de problema. De acordo com a RFC 7807.
          example: https://pix.bcb.gov.br/api/v2/error/NaoEncontrado
          minLength: 0
          maxLength: 99
        title:
          type: string
          description: Descrição resumida do problema.
          example: Not found
          minLength: 0
          maxLength: 99
        status:
          type: integer
          format: int32
          description: Código HTTP do status retornado.
          example: 404
          minimum: 100
          maximum: 599
        detail:
          type: string
          description: Descrição completa do problema.
          minLength: 0
          maxLength: 150
        correlationId:
          type: string
          description: Identificador de correlação do problema para fins de suporte
          minLength: 0
          maxLength: 99
        violacoes:
          type: array
          minItems: 0
          maxItems: 99
          items:
            $ref: '#/components/schemas/Violacao'
    CalendarioCobExpiracao:
      title: CalendarioCobExpiracao
      required:
        - expiracao
      type: object
      description: Os campos aninhados sob o identificador calendário organizam informações a respeito de controle de tempo da cobrança.
      properties:
        expiracao:
          $ref: '#/components/schemas/Expiracao'
    PayloadLocationSolicitadaCob:
      title: PayloadLocationSolicitadaCob
      type: object
      required:
        - id
      description: Identificador da localização do payload.
      properties:
        id:
          $ref: '#/components/schemas/PayloadLocationId'
    CobSolicitada:
      title: CobSolicitada
      type: object
      description: Cobranca imediata solicitada. Dados enviados para criação ou alteração da cobrança imediata via API Pix
      required:
        - valor
        - chave
      properties:
        calendario:
          $ref: '#/components/schemas/CalendarioCobExpiracao'
        devedor:
          $ref: '#/components/schemas/Devedor'
        loc:
          $ref: '#/components/schemas/PayloadLocationSolicitadaCob'
        valor:
          $ref: '#/components/schemas/CobValorMandatorio'
        chave:
          $ref: '#/components/schemas/Chave'
        solicitacaoPagador:
          $ref: '#/components/schemas/SolicitacaoPagador'
        infoAdicionais:
          type: array
          title: InfoAdicionais
          description: Cada respectiva informação adicional contida na lista (nome e valor) deve ser apresentada ao pagador.
          minItems: 0
          maxItems: 50
          items:
            $ref: '#/components/schemas/InfoAdicional'
    PayloadLocation:
      title: PayloadLocation
      type: object
      description: Identificador da localização do payload.
      required:
        - id
        - location
        - tipoCob
        - criacao
      properties:
        id:
          $ref: '#/components/schemas/PayloadLocationId'
        location:
          type: string
          title: Localizacao do payload
          description: Localização do Payload a ser informada na criação da cobrança.
          minLength: 0
          maxLength: 77
          format: uri
          example: https://pix.example.com/qr/v2/2353c790eefb11eaadc10242ac120002
          readOnly: true
        tipoCob:
          $ref: '#/components/schemas/TipoCob'
        criacao:
          $ref: '#/components/schemas/Criacao'
    CobGerada:
      title: CobGerada
      type: object
      description: Dados criados ou alterados da cobrança imediata via API Pix
      required:
        - txid
        - calendario
        - revisao
        - status
        - valor
        - chave
      properties:
        calendario:
          $ref: '#/components/schemas/CalendarioCob'
        txid:
          $ref: '#/components/schemas/TxId'
        revisao:
          $ref: '#/components/schemas/Revisao'
        devedor:
          $ref: '#/components/schemas/Devedor'
        loc:
          $ref: '#/components/schemas/PayloadLocation'
        location:
          type: string
          title: Localizacao do payload
          description: Localização do Payload a ser informada na criação da cobrança.
          minLength: 0
          maxLength: 77
          format: uri
          example: https://pix.example.com/qr/v2/2353c790eefb11eaadc10242ac120002
          readOnly: true
        status:
          $ref: '#/components/schemas/CobrancaStatus'
        valor:
          $ref: '#/components/schemas/CobValorMandatorio'
        pixCopiaECola:
          $ref: '#/components/schemas/PixCopiaECola'
        chave:
          $ref: '#/components/schemas/Chave'
        solicitacaoPagador:
          $ref: '#/components/schemas/SolicitacaoPagador'
        infoAdicionais:
          type: array
          title: InfoAdicionais
          description: Cada respectiva informação adicional contida na lista (nome e valor) deve ser apresentada ao pagador.
          minItems: 0
          maxItems: 50
          items:
            $ref: '#/components/schemas/InfoAdicional'
    CobValor:
      title: CobValor
      description: valores monetários referentes à cobrança.
      type: object
      properties:
        original:
          $ref: '#/components/schemas/Valor'
        modalidadeAlteracao:
          type: integer
          format: int32
          minimum: 0
          maximum: 1
          title: Modalidade de alteracao
          description: Trata-se de um campo que determina se o valor final do documento pode ser alterado pelo pagador. Na ausência desse campo, assume-se que não se pode alterar o valor do documento de cobrança, ou seja, assume-se o valor 0. Se o campo estiver presente e com valor 1, então está determinado que o valor final da cobrança pode ter seu valor alterado pelo pagador.
        retirada:
          $ref: '#/components/schemas/Retirada'
    CobRevisada:
      title: CobRevisada
      type: object
      description: Dados enviados para revisão da cobrança imediata via API Pix
      properties:
        calendario:
          $ref: '#/components/schemas/CalendarioCobExpiracao'
        devedor:
          $ref: '#/components/schemas/Devedor'
        loc:
          $ref: '#/components/schemas/PayloadLocationSolicitadaCob'
        status:
          type: string
          title: Status do registro da cobranca
          enum:
            - REMOVIDA_PELO_USUARIO_RECEBEDOR
        valor:
          $ref: '#/components/schemas/CobValor'
        chave:
          $ref: '#/components/schemas/Chave'
        solicitacaoPagador:
          $ref: '#/components/schemas/SolicitacaoPagador'
        infoAdicionais:
          type: array
          title: InfoAdicionais
          description: Cada respectiva informação adicional contida na lista (nome e valor) deve ser apresentada ao pagador.
          minItems: 0
          maxItems: 50
          items:
            $ref: '#/components/schemas/InfoAdicional'
    Inicio:
      title: Inicio
      type: string
      format: date-time
      example: '2023-10-01T00:00:00Z'
      description: Filtra os registros cuja data de criação seja maior ou igual que a data de início. Respeita RFC 3339.
    Fim:
      title: Fim
      type: string
      format: date-time
      example: '2023-10-02T00:00:00Z'
      description: Filtra os registros cuja data de criação seja menor ou igual que a data de fim. Respeita RFC 3339.
    Paginacao:
      type: object
      title: Paginacao
      description: |
        # Paginação
        A paginação é um objeto que representa a paginação de uma lista de itens.
        Ele é utilizado para descrever a página atual, a quantidade de itens por página, a quantidade total de páginas e a quantidade total de itens disponíveis.
        Esse objeto é retornado em consultas que suportam paginação, como listagens de cobranças, transações, entre outros.
      required:
        - paginaAtual
        - itensPorPagina
        - quantidadeDePaginas
        - quantidadeTotalDeItens
      properties:
        paginaAtual:
          type: integer
          format: int32
          title: Pagina atual
          description: Número da página recuperada.
          minimum: 0
          maximum: 99
        itensPorPagina:
          type: integer
          format: int32
          title: Itens por pagina
          description: Quantidade de registros retornado na página.
          minimum: 1
          maximum: 99
        quantidadeDePaginas:
          type: integer
          format: int32
          title: Quantidade de paginas
          description: Quantidade de páginas disponíveis para consulta.
          minimum: 1
          maximum: 99
        quantidadeTotalDeItens:
          type: integer
          format: int32
          title: Quantidade total de itens
          description: Quantidade total de itens disponíveis de acordo com os parâmetros informados.
          minimum: 0
          maximum: 2147483647
    ParametrosConsultaCob:
      title: ParametrosConsultaCob
      type: object
      description: Parametros de Consulta de Cobranca. [DEPRECADO] Parâmetros utilizados para a realização de uma consulta de cobranças.
      required:
        - inicio
        - fim
        - paginacao
      properties:
        inicio:
          $ref: '#/components/schemas/Inicio'
        fim:
          $ref: '#/components/schemas/Fim'
        cpf:
          $ref: '#/components/schemas/CPF'
        cnpj:
          $ref: '#/components/schemas/CNPJ'
        locationPresente:
          type: boolean
          description: Filtro pela existência de location vinculada.
        status:
          type: string
          title: Status do registro da cobranca
          description: Filtro pelo status das cobranças.
          minLength: 0
          maxLength: 20
        paginacao:
          $ref: '#/components/schemas/Paginacao'
    CobsConsultadas:
      title: CobsConsultadas
      type: object
      description: Cobrancas imediatas consultadas
      required:
        - parametros
        - cobs
      properties:
        parametros:
          $ref: '#/components/schemas/ParametrosConsultaCob'
        cobs:
          type: array
          title: ListaCobrancas
          minItems: 0
          maxItems: 99
          items:
            $ref: '#/components/schemas/CobCompleta'
    DataDeVencimento:
      title: DataDeVencimento
      type: string
      format: date
      description: Trata-se de uma data, no formato `YYYY-MM-DD`, segundo ISO 8601. É a data de vencimento da cobrança. A cobrança pode ser honrada até esse dia, inclusive, em qualquer horário do dia.
      example: '2020-04-01'
    ValidadeAposVencimento:
      title: ValidadeAposVencimento
      type: integer
      format: int32
      description: "Trata-se da quantidade de dias corridos após calendario.dataDeVencimento,\nem que a cobrança poderá ser paga.\n\nSempre que a data de vencimento cair em um fim de semana ou em um feriado para o usuário pagador,\n ela deve ser automaticamente prorrogada para o primeiro dia útil subsequente. Todos os campos \n que façam referência a esta data (`validadeAposVencimento`; `desconto`; `juros` e `multa`) devem assumir \n essa prorrogação, quando for o caso.\n\nPara ilustrar o funcionamento, seguem alguns exemplos, onde:\n- ``(#)`` representa a data de vencimento;\n- ``(*)`` representa a data ajustada em função de dias não úteis;\n- os ``(<número>)`` correspondem aos dias adicionais de validade para o pagamento.\n\nExemplo A:\n\n```txt\ndataDeVencimento: 2020-10-20, terça-feira.\nvalidadeAposVencimento: 4\n\nTenta-se pagar no dia 2020-10-20, terça: aceito. (#)(*)\nTenta-se pagar no dia 2020-10-21, quarta: aceito. (1)\nTenta-se pagar no dia 2020-10-22, quinta: aceito. (2)\nTenta-se pagar no dia 2020-10-23, sexta: aceito. (3)\nTenta-se pagar no dia 2020-10-24, sábado: aceito. \nTenta-se pagar no dia 2020-10-25, domingo: aceito. (Feriado)\nTenta-se pagar no dia 2020-10-26, segunda: aceito. (4)\nTenta-se pagar no dia 2020-10-27, terça: negado.\n```\n\nExemplo B:\n\n```txt\ndataDeVencimento: 2020-12-25, sexta-feira, feriado.\nvalidadeAposVencimento: 0\n\nTenta-se pagar no dia 2020-12-25, sexta: aceito. (#)(Feriado)\nTenta-se pagar no dia 2020-12-26, sábado: aceito.\nTenta-se pagar no dia 2020-12-27, domingo: aceito.\nTenta-se pagar no dia 2020-12-28, segunda: aceito. (*)\nTenta-se pagar no dia 2020-12-29, terça: negado.\n```\n\nExemplo C:\n\n```txt\ndataDeVencimento: 2020-12-25, sexta-feira, feriado.\nvalidadeAposVencimento: 1\n\nTenta-se pagar no dia 2020-12-25, sexta: aceito. (#)(Feriado)\nTenta-se pagar no dia 2020-12-26, sábado: aceito.\nTenta-se pagar no dia 2020-12-27, domingo: aceito.\nTenta-se pagar no dia 2020-12-28, segunda: aceito. (*)\nTenta-se pagar no dia 2020-12-29, terça: aceito. (1)\nTenta-se pagar no dia 2020-12-30, quarta: negado.\n```\n\nExemplo D:\n\n```txt\ndataDeVencimento: 2020-12-25, sexta-feira, feriado.\nvalidadeAposVencimento: 3\n\nTenta-se pagar no dia 2020-12-25, sexta: aceito. (#)(Feriado)\nTenta-se pagar no dia 2020-12-26, sábado: aceito.\nTenta-se pagar no dia 2020-12-27, domingo: aceito.\nTenta-se pagar no dia 2020-12-28, segunda: aceito. (*)\nTenta-se pagar no dia 2020-12-29, terça: aceito. (1)\nTenta-se pagar no dia 2020-12-30, quarta: aceito. (2)\nTenta-se pagar no dia 2020-12-31, quinta: aceito. (3)\nTenta-se pagar no dia 2021-01-01, sexta: negado.\n```\n\nExemplo E:\n\n```txt\ndataDeVencimento: 2020-12-25, sexta-feira, feriado.\nvalidadeAposVencimento: 4\n\nTenta-se pagar no dia 2020-12-25, sexta: aceito. (#)(Feriado)\nTenta-se pagar no dia 2020-12-26, sábado: aceito.\nTenta-se pagar no dia 2020-12-27, domingo: aceito.\nTenta-se pagar no dia 2020-12-28, segunda: aceito. (*)\nTenta-se pagar no dia 2020-12-29, terça: aceito. (1)\nTenta-se pagar no dia 2020-12-30, quarta: aceito. (2)\nTenta-se pagar no dia 2020-12-31, quinta: aceito. (3)\nTenta-se pagar no dia 2021-01-01, sexta: aceito. (Feriado)\nTenta-se pagar no dia 2021-01-02, sábado: aceito.\nTenta-se pagar no dia 2021-01-03, domingo: aceito.\nTenta-se pagar no dia 2021-01-04, segunda: aceito. (4)\nTenta-se pagar no dia 2021-01-05, terça: negado. \n```\n\nExemplo F:\n\n```txt\ndataDeVencimento: 2021-08-27, sexta-feira.\nvalidadeAposVencimento: 5\n\nTenta-se pagar no dia 2021-08-27, sexta: aceito. (#)(*)\nTenta-se pagar no dia 2021-08-28, sábado: aceito. (1)\nTenta-se pagar no dia 2021-08-29, domingo: aceito. (2)\nTenta-se pagar no dia 2021-08-30, segunda: aceito. (3)\nTenta-se pagar no dia 2021-08-31, terça: aceito. (4)\nTenta-se pagar no dia 2021-09-01, quarta: aceito. (5)\nTenta-se pagar no dia 2021-09-02, quinta: negado. \n```\n\nExemplo G:\n\n```txt\ndataDeVencimento: 2021-08-28, sábado.\nvalidadeAposVencimento: 5\n\nTenta-se pagar no dia 2021-08-28, sábado: aceito. (#)\nTenta-se pagar no dia 2021-08-29, domingo: aceito. \nTenta-se pagar no dia 2021-08-30, segunda: aceito. (*)\nTenta-se pagar no dia 2021-08-31, terça: aceito. (1)\nTenta-se pagar no dia 2021-09-01, quarta: aceito. (2)\nTenta-se pagar no dia 2021-09-02, quinta: aceito. (3)\nTenta-se pagar no dia 2021-09-03, sexta: aceito. (4)\nTenta-se pagar no dia 2021-09-04, sabado: aceito. \nTenta-se pagar no dia 2021-09-05, domingo: aceito. \nTenta-se pagar no dia 2021-09-06, segunda: aceito. (5) \n```\n"
      default: 30
      minimum: 0
      maximum: 365
    CalendarioCobV:
      title: CalendarioCobV
      required:
        - dataDeVencimento
        - validadeAposVencimento
      description: Calendario Cobranca com Vencimento. Os campos aninhados sob o identificador calendário organizam informações a respeito de controle de tempo da cobrança.
      type: object
      properties:
        criacao:
          $ref: '#/components/schemas/Criacao'
        dataDeVencimento:
          $ref: '#/components/schemas/DataDeVencimento'
        validadeAposVencimento:
          $ref: '#/components/schemas/ValidadeAposVencimento'
    DadosComplementaresPessoa:
      title: DadosComplementaresPessoa
      description: Objeto que organiza as informações complementares de uma pessoa, como logradouro, cidade, UF e CEP.
      type: object
      properties:
        logradouro:
          type: string
          title: Logradouro
          description: Logradouro do usuário.
          minLength: 0
          maxLength: 200
        cidade:
          type: string
          title: Cidade
          description: Cidade do usuário.
          minLength: 0
          maxLength: 200
        uf:
          type: string
          title: UF
          description: UF do usuário.
          minLength: 0
          maxLength: 2
        cep:
          type: string
          title: CEP
          description: CEP do usuário.
          minLength: 0
          maxLength: 8
    DadosDevedor:
      title: DadosDevedor
      description: O objeto devedor organiza as informações sobre o devedor da cobrança.
      type: object
      allOf:
        - $ref: '#/components/schemas/DadosComplementaresPessoa'
      required:
        - nome
      properties:
        email:
          type: string
          title: Email
          description: Email do usuário.
          minLength: 0
          maxLength: 77
        nome:
          $ref: '#/components/schemas/NomeUsuario'
        cpf:
          $ref: '#/components/schemas/CPF'
        cnpj:
          $ref: '#/components/schemas/CNPJ'
      oneOf:
        - required:
            - cpf
          type: object
        - required:
            - cnpj
          type: object
    PessoaJuridicaExt:
      title: PessoaJuridicaExt
      type: object
      description: Pessoa Juridica Com Nome Fantasia
      required:
        - cnpj
        - nome
      properties:
        cnpj:
          $ref: '#/components/schemas/CNPJ'
        nome:
          $ref: '#/components/schemas/NomeUsuario'
        nomeFantasia:
          type: string
          title: Nome fantasia
          description: Nome fantasia.
          minLength: 0
          maxLength: 200
    DadosRecebedor:
      title: DadosRecebedor
      type: object
      required:
        - logradouro
        - cidade
        - uf
        - cep
      description: O objeto recebedor organiza as informações sobre o credor da cobrança.
      allOf:
        - $ref: '#/components/schemas/DadosComplementaresPessoa'
        - oneOf:
            - $ref: '#/components/schemas/PessoaFisica'
            - $ref: '#/components/schemas/PessoaJuridicaExt'
    Multa:
      title: Multa
      description: Multa aplicada à cobrança
      type: object
      required:
        - modalidade
        - valorPerc
      properties:
        modalidade:
          type: integer
          format: int32
          title: Modalidade da multa
          minimum: 1
          maximum: 2
          description: |
            ##### Modalidade da multa, conforme tabela de domínios.
            <table><tr><th>Descrição</th><th>Domínio</th></tr><tr><td>Valor Fixo</td><td>1</td></tr><tr><td>Percentual</td><td>2</td></tr></table>
        valorPerc:
          $ref: '#/components/schemas/Valor'
    Juros:
      title: Juros
      description: Juro aplicado à cobrança
      type: object
      required:
        - modalidade
        - valorPerc
      properties:
        modalidade:
          type: integer
          format: int32
          minimum: 1
          maximum: 8
          title: Modalidade de juros
          description: |
            ##### Modalidade de juros, conforme tabela de domínios.
            <table><tr><th>Descrição</th><th>Domínio</th></tr><tr><td>Valor (dias corridos)</td><td>1</td></tr><tr><td>Percentual ao dia (dias corridos)</td><td>2</td></tr><tr><td>Percentual ao mês (dias corridos)</td><td>3</td></tr><tr><td>Percentual ao ano (dias corridos)</td><td>4</td></tr><tr><td>Valor (dias úteis)</td><td>5</td></tr><tr><td>Percentual ao dia (dias úteis)</td><td>6</td></tr><tr><td>Percentual ao mês (dias úteis)</td><td>7</td></tr><tr><td>Percentual ao ano (dias úteis)</td><td>8</td></tr></table>
        valorPerc:
          $ref: '#/components/schemas/Valor'
    Abatimento:
      title: Abatimento
      description: Abatimento aplicado à cobrança
      type: object
      required:
        - modalidade
        - valorPerc
      properties:
        modalidade:
          type: integer
          format: int32
          minimum: 1
          maximum: 2
          title: Modalidade de abatimentos
          description: |
            ##### Modalidade de abatimentos, conforme tabela de domínios.
            <table><tr><th>Descrição</th><th>Domínio</th></tr><tr><td>Valor Fixo</td><td>1</td></tr><tr><td>Percentual</td><td>2</td></tr></table>
        valorPerc:
          $ref: '#/components/schemas/Valor'
    ModalidadeDesconto:
      title: ModalidadeDesconto
      description: |
        ##### Modalidade de desconto, conforme tabela de domínios.
        <table><tr><th>Descrição</th><th>Domínio</th></tr><tr><td>Valor Fixo até a[s] data[s] informada[s]</td><td>1</td></tr><tr><td>Percentual até a data informada</td><td>2</td></tr><tr><td>Valor por antecipação dia corrido</td><td>3</td></tr><tr><td>Valor por antecipação dia útil</td><td>4</td></tr><tr><td>Percentual por antecipação dia corrido</td><td>5</td></tr><tr><td>Percentual por antecipação dia útil</td><td>6</td></tr></table>
      type: integer
      format: int32
      minimum: 1
      maximum: 6
    DescontoDataFixa:
      title: DescontoDataFixa
      description: Descontos por pagamento antecipado, com data fixa. Matriz com até três elementos, sendo que cada elemento é composto por um par "data e valorPerc", para estabelecer descontos percentuais ou absolutos, até aquela data de pagamento. Trata-se de uma data, no formato `YYYY-MM-DD`, segundo ISO 8601. A data de desconto obrigatoriamente deverá ser menor ou igual à data de vencimento da cobrança.
      type: object
      required:
        - data
        - valorPerc
      properties:
        data:
          title: Data limite para o desconto absoluto da cobranca
          description: Descontos por pagamento antecipado, com data fixa. Matriz com até três elementos, sendo que cada elemento é composto por um par "data e valorPerc", para estabelecer descontos percentuais ou absolutos, até aquela data de pagamento. Trata-se de uma data, no formato `YYYY-MM-DD`, segundo ISO 8601. A data de desconto obrigatoriamente deverá ser menor ou igual à data de vencimento da cobrança.
          type: string
          format: date
          example: '2020-04-01'
        valorPerc:
          $ref: '#/components/schemas/Valor'
    Desconto:
      title: Desconto
      type: object
      required:
        - modalidade
      description: Descontos aplicados à cobrança
      allOf:
        - type: object
          title: Modalidade
          description: Modalidade do desconto aplicado à cobrança.
          properties:
            modalidade:
              $ref: '#/components/schemas/ModalidadeDesconto'
            descontoDataFixa:
              title: DescontosDataFixa
              description: Descontos absolutos aplicados à cobrança.
              type: array
              minItems: 0
              maxItems: 3
              uniqueItems: true
              items:
                $ref: '#/components/schemas/DescontoDataFixa'
            valorPerc:
              $ref: '#/components/schemas/Valor'
    CobVValorMandatorio:
      title: CobVValor
      type: object
      description: Valores monetários da cobranca com vencimento.
      required:
        - original
      properties:
        original:
          $ref: '#/components/schemas/Valor'
        multa:
          $ref: '#/components/schemas/Multa'
        juros:
          $ref: '#/components/schemas/Juros'
        abatimento:
          $ref: '#/components/schemas/Abatimento'
        desconto:
          $ref: '#/components/schemas/Desconto'
    CobVCompleta:
      title: CobVCompleta
      type: object
      required:
        - txid
        - devedor
        - calendario
        - revisao
        - status
        - valor
        - chave
        - recebedor
      properties:
        calendario:
          $ref: '#/components/schemas/CalendarioCobV'
        txid:
          $ref: '#/components/schemas/TxId'
        revisao:
          $ref: '#/components/schemas/Revisao'
        devedor:
          $ref: '#/components/schemas/DadosDevedor'
        recebedor:
          $ref: '#/components/schemas/DadosRecebedor'
        loc:
          $ref: '#/components/schemas/PayloadLocation'
        status:
          $ref: '#/components/schemas/CobrancaStatus'
        valor:
          $ref: '#/components/schemas/CobVValorMandatorio'
        pixCopiaECola:
          $ref: '#/components/schemas/PixCopiaECola'
        chave:
          $ref: '#/components/schemas/Chave'
        solicitacaoPagador:
          $ref: '#/components/schemas/SolicitacaoPagador'
        infoAdicionais:
          type: array
          title: InfoAdicionais
          description: Cada respectiva informação adicional contida na lista (nome e valor) deve ser apresentada ao pagador.
          minItems: 0
          maxItems: 50
          items:
            $ref: '#/components/schemas/InfoAdicional'
        pix:
          type: array
          minItems: 0
          maxItems: 25
          title: PixRecebidos
          items:
            type: object
            title: PixRecebido
            allOf:
              - $ref: '#/components/schemas/Pix'
              - type: object
                properties:
                  txid:
                    $ref: '#/components/schemas/TxId'
    CobDataDeVencimento:
      title: CobDataDeVencimento
      description: |
        Este objeto representa a data de vencimento da cobrança e a validade após o vencimento.
        A data de vencimento é obrigatória e deve ser informada no formato `YYYY-MM-DD`.
        A validade após o vencimento é opcional e indica quantos dias corridos a mais a cobrança poderá ser paga após a data de vencimento.
        Se não for informado, assume-se que a cobrança não pode ser paga após o vencimento.
      type: object
      required:
        - dataDeVencimento
      properties:
        dataDeVencimento:
          $ref: '#/components/schemas/DataDeVencimento'
        validadeAposVencimento:
          $ref: '#/components/schemas/ValidadeAposVencimento'
    CobVSolicitada:
      title: CobVSolicitada
      type: object
      description: Dados enviados para criação ou alteração da cobrança com vencimento via API Pix
      required:
        - valor
        - chave
        - devedor
        - calendario
      properties:
        calendario:
          $ref: '#/components/schemas/CobDataDeVencimento'
        devedor:
          $ref: '#/components/schemas/DadosDevedor'
        loc:
          $ref: '#/components/schemas/PayloadLocationSolicitadaCob'
        valor:
          $ref: '#/components/schemas/CobVValorMandatorio'
        chave:
          $ref: '#/components/schemas/Chave'
        solicitacaoPagador:
          $ref: '#/components/schemas/SolicitacaoPagador'
        infoAdicionais:
          type: array
          title: InfoAdicionais
          description: Cada respectiva informação adicional contida na lista (nome e valor) deve ser apresentada ao pagador.
          minItems: 0
          maxItems: 50
          items:
            $ref: '#/components/schemas/InfoAdicional'
    CobVGerada:
      title: CobVGerada
      type: object
      description: Dados criados ou alterados da cobrança com vencimento via API Pix
      required:
        - txid
        - devedor
        - calendario
        - revisao
        - status
        - valor
        - chave
        - recebedor
      properties:
        calendario:
          $ref: '#/components/schemas/CalendarioCobV'
        txid:
          $ref: '#/components/schemas/TxId'
        revisao:
          $ref: '#/components/schemas/Revisao'
        devedor:
          $ref: '#/components/schemas/DadosDevedor'
        recebedor:
          $ref: '#/components/schemas/DadosRecebedor'
        loc:
          $ref: '#/components/schemas/PayloadLocation'
        status:
          $ref: '#/components/schemas/CobrancaStatus'
        valor:
          $ref: '#/components/schemas/CobVValorMandatorio'
        pixCopiaECola:
          $ref: '#/components/schemas/PixCopiaECola'
        chave:
          $ref: '#/components/schemas/Chave'
        solicitacaoPagador:
          $ref: '#/components/schemas/SolicitacaoPagador'
        infoAdicionais:
          type: array
          title: InfoAdicionais
          description: Cada respectiva informação adicional contida na lista (nome e valor) deve ser apresentada ao pagador.
          minItems: 0
          maxItems: 50
          items:
            $ref: '#/components/schemas/InfoAdicional'
    CobVValor:
      title: CobVValor
      type: object
      description: Valores monetários da cobranca com vencimento.
      properties:
        original:
          $ref: '#/components/schemas/Valor'
        multa:
          $ref: '#/components/schemas/Multa'
        juros:
          $ref: '#/components/schemas/Juros'
        abatimento:
          $ref: '#/components/schemas/Abatimento'
        desconto:
          $ref: '#/components/schemas/Desconto'
    CobVRevisada:
      title: CobVRevisada
      type: object
      description: Dados enviados para revisão da cobrança com vencimento via API Pix
      properties:
        calendario:
          $ref: '#/components/schemas/CobDataDeVencimento'
        devedor:
          $ref: '#/components/schemas/DadosDevedor'
        loc:
          $ref: '#/components/schemas/PayloadLocationSolicitadaCob'
        status:
          type: string
          title: Status do registro da cobrança
          enum:
            - REMOVIDA_PELO_USUARIO_RECEBEDOR
        valor:
          $ref: '#/components/schemas/CobVValor'
        chave:
          $ref: '#/components/schemas/Chave'
        solicitacaoPagador:
          $ref: '#/components/schemas/SolicitacaoPagador'
        infoAdicionais:
          type: array
          title: InfoAdicionais
          description: Cada respectiva informação adicional contida na lista (nome e valor) deve ser apresentada ao pagador.
          minItems: 0
          maxItems: 50
          items:
            $ref: '#/components/schemas/InfoAdicional'
    CobsVConsultadas:
      title: CobsVConsultadas
      type: object
      description: Cobrancas com vencimento consultadas
      required:
        - parametros
        - cobs
      properties:
        parametros:
          $ref: '#/components/schemas/ParametrosConsultaCob'
        cobs:
          type: array
          title: Lista Cobrancas
          minItems: 0
          maxItems: 99
          items:
            $ref: '#/components/schemas/CobVCompleta'
    ParametrosConsultaPayloadLocation:
      title: ParametrosConsultaPayloadLocation
      type: object
      description: Parâmetros utilizados para a realização de uma consulta de locations.
      required:
        - inicio
        - fim
        - paginacao
      properties:
        inicio:
          $ref: '#/components/schemas/Inicio'
        fim:
          $ref: '#/components/schemas/Fim'
        txIdPresente:
          type: boolean
          description: Filtro pela existência de txid.
        tipoCob:
          $ref: '#/components/schemas/TipoCob'
        paginacao:
          $ref: '#/components/schemas/Paginacao'
    PayloadLocationConsultadas:
      title: PayloadLocationConsultadas
      type: object
      description: Locations Consultadas
      required:
        - parametros
        - loc
      properties:
        parametros:
          $ref: '#/components/schemas/ParametrosConsultaPayloadLocation'
        loc:
          type: array
          minItems: 0
          maxItems: 99
          title: Lista de locations cadastradas
          items:
            $ref: '#/components/schemas/PayloadLocationCompleta'
    PayloadLocationSolicitada:
      title: PayloadLocationSolicitadaCob
      type: object
      required:
        - tipoCob
      description: Identificador da localização do payload.
      properties:
        tipoCob:
          $ref: '#/components/schemas/TipoCob'
  parameters:
    txid:
      name: txid
      description: Id da Transaçao
      in: path
      required: true
      schema:
        $ref: '#/components/schemas/TxId'
      examples:
        cob:
          summary: Id da transaçao com QR Code Dinamico e vencimento imediato
          value: 1062ad7dee5c4611962733d4ce5cf9c9
        cobv:
          summary: Id da transaçao com QR Code Dinamico e vencimento por data
          value: 05df6aaa4fea44128795a1d42b5e3e45
    revisao:
      name: revisao
      description: Revisão
      in: query
      required: false
      schema:
        $ref: '#/components/schemas/Revisao'
    inicio:
      in: query
      name: inicio
      required: true
      schema:
        $ref: '#/components/schemas/Inicio'
      description: Data de inicio
    fim:
      in: query
      name: fim
      required: true
      schema:
        $ref: '#/components/schemas/Fim'
      description: Data de fim
    locacaoPresente:
      name: locationPresente
      description: Indicador de locaçao presente
      in: query
      schema:
        type: boolean
    status:
      name: status
      description: Filtro pelo status da cobrança.
      in: query
      schema:
        type: string
        minLength: 0
        maxLength: 32
        title: Status do registro da cobranca
        description: Filtro pelo status da cobrança.
        enum:
          - ATIVA
          - CONCLUIDA
          - REMOVIDA_PELO_USUARIO_RECEBEDOR
          - REMOVIDA_PELO_PSP
    paginaAtual:
      in: query
      description: Página a ser retornada pela consulta. Se não for informada, o PSP assumirá que será 0.
      name: paginacao.paginaAtual
      required: false
      schema:
        type: integer
        format: int32
        title: Pagina atual
        minimum: 0
        maximum: 99
        default: 0
        description: Página a ser retornada pela consulta. Se não for informada, o PSP assumirá que será 0.
    itensPorPagina:
      in: query
      description: Quantidade máxima de registros retornados em cada página. Apenas a última página pode conter uma quantidade menor de registros.
      name: paginacao.itensPorPagina
      required: false
      schema:
        type: integer
        format: int32
        title: Itens por Pagina
        minimum: 1
        maximum: 99
        default: 99
        description: Quantidade máxima de registros retornados em cada página. Apenas a última página pode conter uma quantidade menor de registros.
    idLoteInteger:
      name: loteCobVId
      description: Id do lote de cobrança com vencimento.
      in: query
      schema:
        type: integer
        format: int32
        title: Id do lote de cobranca com vencimento
        description: Id do lote de cobrança com vencimento.
        minimum: 0
        maximum: 2147483647
    txIdPresente:
      name: txIdPresente
      in: query
      schema:
        type: boolean
      description: Indicador de txId presente
    tipoCob:
      name: tipoCob
      in: query
      schema:
        type: string
        enum:
          - cob
          - cobv
      description: Tipo de cobrança
    idLocation:
      name: id
      description: Id da location cadastrada para servir um payload
      in: path
      required: true
      schema:
        type: string
        minLength: 0
        maxLength: 128
        title: Id da location cadastrada para servir um payload
      examples:
        cob:
          summary: Id da location cadastrada para servir um payload immediato
          value: '12345'
        cobv:
          summary: Id da location cadastrada para servir um payload com vencimento
          value: '98765'
  examples:
    cobResponse1:
      summary: Exemplo de cobrança imediata 1
      value:
        calendario:
          criacao: '2020-09-09T20:15:00.358Z'
          expiracao: 3600
        txid: 7978c0c97ea847e78e8849634473c1f1
        revisao: 0
        loc:
          id: 789
          txid: 7978c0c97ea847e78e8849634473c1f1
          location: https://pix.example.com/qr/9d36b84fc70b478fb95c12729b90ca25
          tipoCob: cob
          criacao: '2020-09-09T20:15:00.358Z'
        location: https://pix.example.com/qr/9d36b84fc70b478fb95c12729b90ca25
        status: ATIVA
        devedor:
          cnpj: '12345678000195'
          nome: Empresa de Serviços SA
        valor:
          original: '37.00'
          modalidadeAlteracao: 1
        chave: 7d9f0335-8dcc-4054-9bf9-0dbd61d36906
        solicitacaoPagador: Serviço realizado.
        infoAdicionais:
          - nome: Campo 1
            valor: Informação Adicional1 do PSP-Recebedor
          - nome: Campo 2
            valor: Informação Adicional2 do PSP-Recebedor
    cobResponse2:
      summary: Exemplo de cobrança imediata 2
      value:
        calendario:
          criacao: '2020-09-09T20:15:00.358Z'
          expiracao: 3600
        txid: 655dfdb1a4514b8fbb58254b958913fb
        revisao: 1
        loc:
          id: 567
          txid: 655dfdb1a4514b8fbb58254b958913fb
          location: https://pix.example.com/qr/1dd7f893a58e417287028dc33e21a403
          tipoCob: cob
          criacao: '2020-09-09T20:15:00.358Z'
        location: https://pix.example.com/qr/1dd7f893a58e417287028dc33e21a403
        status: CONCLUIDA
        devedor:
          cnpj: '12345678000195'
          nome: Empresa de Serviços SA
        valor:
          original: '100.00'
          modalidadeAlteracao: 0
        chave: 40a0932d-1918-4eee-845d-35a2da1690dc
        solicitacaoPagador: Informar cartão fidelidade
        pix:
          - endToEndId: E12345678202009091221kkkkkkkkkkk
            txid: 655dfdb1a4514b8fbb58254b958913fb
            valor: '110.00'
            horario: '2020-09-09T20:15:00.358Z'
            infoPagador: '0123456789'
            devolucoes:
              - id: 123ABC
                rtrId: Dxxxxxxxx202009091221kkkkkkkkkkk
                valor: '10.00'
                horario:
                  solicitacao: '2020-09-09T20:15:00.358Z'
                status: EM_PROCESSAMENTO
    cobResponse5:
      summary: Exemplo de cobrança imediata com Saque Pix
      value:
        calendario:
          criacao: '2020-09-09T20:15:00.358Z'
          expiracao: 3600
        txid: 33beb661beda44a8928fef47dbeb2dc5
        revisao: 0
        loc:
          id: 1004
          txid: 33beb661beda44a8928fef47dbeb2dc5
          location: https://pix.example.com/qr/7faa6893c4e64893a503baf0d40af213
          tipoCob: cob
          criacao: '2020-09-09T20:15:00.358Z'
        location: https://pix.example.com/qr/7faa6893c4e64893a503baf0d40af213
        status: ATIVA
        devedor:
          cnpj: '12345678000195'
          nome: Empresa de Serviços SA
        valor:
          original: '0.00'
          modalidadeAlteracao: 0
          retirada:
            saque:
              valor: '5.00'
              modalidadeAlteracao: 0
              modalidadeAgente: AGPSS
              prestadorDoServicoDeSaque: '12345678'
        chave: 7d9f0335-8dcc-4054-9bf9-0dbd61d36906
    cobResponse6:
      summary: Exemplo de cobrança imediata com Saque Pix 2
      value:
        calendario:
          criacao: '2020-09-09T20:15:00.358Z'
          expiracao: 3600
        txid: 33beb661beda44a8928fef47dbeb2dc5
        revisao: 0
        loc:
          id: 1004
          txid: 33beb661beda44a8928fef47dbeb2dc5
          location: https://pix.example.com/qr/7faa6893c4e64893a503baf0d40af213
          tipoCob: cob
          criacao: '2020-09-09T20:15:00.358Z'
        location: https://pix.example.com/qr/7faa6893c4e64893a503baf0d40af213
        status: ATIVA
        devedor:
          cnpj: '12345678000195'
          nome: Empresa de Serviços SA
        valor:
          original: '0.00'
          modalidadeAlteracao: 0
          retirada:
            saque:
              valor: '20.00'
              modalidadeAlteracao: 1
              modalidadeAgente: AGPSS
              prestadorDoServicoDeSaque: '12345678'
        chave: 7d9f0335-8dcc-4054-9bf9-0dbd61d36906
    cobResponse7:
      summary: Exemplo de cobrança imediata com Saque Pix 3
      value:
        calendario:
          criacao: '2020-09-09T20:15:00.358Z'
          expiracao: 3600
        txid: 33beb661beda44a8928fef47dbeb2dc5
        revisao: 0
        loc:
          id: 1004
          txid: 33beb661beda44a8928fef47dbeb2dc5
          criacao: '2020-09-09T20:15:00.358Z'
          location: https://pix.example.com/qr/7faa6893c4e64893a503baf0d40af213
          tipoCob: cob
        location: https://pix.example.com/qr/7faa6893c4e64893a503baf0d40af213
        status: ATIVA
        devedor:
          cnpj: '12345678000195'
          nome: Empresa de Serviços SA
        valor:
          original: '10.00'
          modalidadeAlteracao: 0
          retirada:
            troco:
              valor: '0.00'
              modalidadeAlteracao: 1
              modalidadeAgente: AGTEC
              prestadorDoServicoDeSaque: '12345678'
        chave: 7d9f0335-8dcc-4054-9bf9-0dbd61d36906
    RequisicaoInvalidaCobGetExample1:
      summary: Exemplo de erro da requisição 1
      value:
        type: https://pix.bcb.gov.br/api/v2/error/CobOperacaoInvalida
        title: Requisição invalida.
        status: 400
        detail: A requisição não respeita o _schema_ ou está semanticamente errada.
        violacoes:
          - razao: O campo txid não respeita o _schema_.
            propriedade: txid
    AcessoNegadoExample1:
      summary: Exemplo de erro da requisição 1
      value:
        type: https://pix.bcb.gov.br/api/v2/error/AcessoNegado
        title: Acesso Negado
        status: 403
        detail: Requisição de participante autenticado que viola alguma regra de autorização.
    NaoEncontradoExample1:
      summary: Exemplo de erro da requisição 1
      value:
        type: https://pix.bcb.gov.br/api/v2/error/NaoEncontrado
        title: Nao Encontrado
        status: 404
        detail: Entidade não encontrada.
    ServicoIndisponivelExample1:
      summary: Exemplo de erro da requisição 1
      value:
        type: https://pix.bcb.gov.br/api/v2/error/ServicoIndisponivel
        title: Servico Indisponivel
        status: 503
        detail: O serviço está temporariamente indisponível.
    cobBody2:
      summary: Exemplo de criação de cobrança imediata 1
      value:
        calendario:
          expiracao: 3600
        devedor:
          cnpj: '12345678000195'
          nome: Empresa de Serviços SA
        valor:
          original: '37.00'
          modalidadeAlteracao: 1
        chave: 7d9f0335-8dcc-4054-9bf9-0dbd61d36906
        solicitacaoPagador: Serviço realizado.
        infoAdicionais:
          - nome: Campo 1
            valor: Informação Adicional1 do PSP-Recebedor
          - nome: Campo 2
            valor: Informação Adicional2 do PSP-Recebedor
    cobBody6:
      summary: Exemplo de criação de cobrança imediata com Saque Pix
      value:
        devedor:
          cnpj: '12345678000195'
          nome: Empresa de Serviços SA
        valor:
          original: '0.00'
          modalidadeAlteracao: 0
          retirada:
            saque:
              valor: '5.00'
              modalidadeAlteracao: 0
              modalidadeAgente: AGPSS
              prestadorDoServicoDeSaque: '12345678'
        chave: 7d9f0335-8dcc-4054-9bf9-0dbd61d36906
    cobBody8:
      summary: Exemplo de criação de cobrança imediata com Saque Pix 2
      value:
        devedor:
          cnpj: '12345678000195'
          nome: Empresa de Serviços SA
        valor:
          original: '0.00'
          modalidadeAlteracao: 0
          retirada:
            saque:
              valor: '20.00'
              modalidadeAlteracao: 1
              modalidadeAgente: AGPSS
              prestadorDoServicoDeSaque: '12345678'
        chave: 7d9f0335-8dcc-4054-9bf9-0dbd61d36906
    cobBody9:
      summary: Exemplo de criação de cobrança imediata com Saque Pix 3
      value:
        devedor:
          cnpj: '12345678000195'
          nome: Empresa de Serviços SA
        valor:
          original: '10.00'
          modalidadeAlteracao: 0
          retirada:
            troco:
              valor: '0.00'
              modalidadeAlteracao: 1
              modalidadeAgente: AGTEC
              prestadorDoServicoDeSaque: '12345678'
        chave: 7d9f0335-8dcc-4054-9bf9-0dbd61d36906
    RequisicaoInvalidaCobExample1:
      summary: Exemplo de erro da requisição 1
      value:
        type: https://pix.bcb.gov.br/api/v2/error/CobOperacaoInvalida
        title: Cobranca invalida.
        status: 400
        detail: A requisição que busca alterar ou criar uma cobrança para pagamento imediato não respeita o _schema_ ou está semanticamente errada.
        violacoes:
          - razao: O campo cob.valor.original não respeita o _schema_.
            propriedade: cob.valor.original
    cobBody3:
      summary: Exemplo de revisão de cobrança 1
      value:
        loc:
          id: 7768
        devedor:
          cpf: '12345678909'
          nome: Francisco da Silva
        valor:
          original: '123.45'
        solicitacaoPagador: Cobrança dos serviços prestados.
    cobBody4:
      summary: Exemplo de revisão de cobrança 2
      value:
        valor:
          original: '567.89'
        solicitacaoPagador: Informar cartão fidelidade
    cobBody5:
      summary: Exemplo de revisão de cobrança 3
      value:
        status: REMOVIDA_PELO_USUARIO_RECEBEDOR
    cobResponse3:
      summary: Exemplo de cobrança revisada 1
      value:
        calendario:
          criacao: '2020-09-09T20:15:00.358Z'
          expiracao: 3600
        txid: 7978c0c97ea847e78e8849634473c1f1
        revisao: 1
        loc:
          id: 7768
          txid: 7978c0c97ea847e78e8849634473c1f1
          location: https://pix.example.com/qr/b1/9d36b84fc70b478fb95c12729b90ca25
          tipoCob: cob
          criacao: '2020-09-09T20:15:00.358Z'
        location: https://pix.example.com/qr/v1/9d36b84fc70b478fb95c12729b90ca25
        status: ATIVA
        devedor:
          cpf: '12345678909'
          nome: Francisco da Silva
        valor:
          original: '123.45'
          modalidadeAlteracao: 0
        chave: a1f4102e-a446-4a57-bcce-6fa48899c1d1
        solicitacaoPagador: Cobrança dos serviços prestados.
    getCobs1:
      summary: Exemplo de retorno da consulta de cobranças 1
      value:
        parametros:
          inicio: '2020-04-01T00:00:00Z'
          fim: '2020-04-02T10:00:00Z'
          paginacao:
            paginaAtual: 0
            itensPorPagina: 99
            quantidadeDePaginas: 1
            quantidadeTotalDeItens: 5
        cobs:
          - calendario:
              criacao: '2020-09-09T20:15:00.358Z'
              expiracao: 3600
            txid: 7978c0c97ea847e78e8849634473c1f1
            revisao: 0
            loc:
              id: 789
              txid: 7978c0c97ea847e78e8849634473c1f1
              location: https://pix.example.com/qr/9d36b84fc70b478fb95c12729b90ca25
              tipoCob: cob
              criacao: '2020-09-09T20:15:00.358Z'
            location: https://pix.example.com/qr/9d36b84fc70b478fb95c12729b90ca25
            status: ATIVA
            devedor:
              cnpj: '12345678000195'
              nome: Empresa de Serviços SA
            valor:
              original: '37.00'
              modalidadeAlteracao: 1
            chave: 7d9f0335-8dcc-4054-9bf9-0dbd61d36906
            solicitacaoPagador: Serviço realizado.
            infoAdicionais:
              - nome: Campo 1
                valor: Informação Adicional1 do PSP-Recebedor
              - nome: Campo 2
                valor: Informação Adicional2 do PSP-Recebedor
          - calendario:
              criacao: '2020-09-09T20:15:00.358Z'
              expiracao: 3600
            txid: 655dfdb1a4514b8fbb58254b958913fb
            revisao: 1
            loc:
              id: 567
              txid: 655dfdb1a4514b8fbb58254b958913fb
              location: https://pix.example.com/qr/1dd7f893a58e417287028dc33e21a403
              tipoCob: cob
              criacao: '2020-09-09T20:15:00.358Z'
            location: https://pix.example.com/qr/1dd7f893a58e417287028dc33e21a403
            status: CONCLUIDA
            devedor:
              cnpj: '12345678000195'
              nome: Empresa de Serviços SA
            valor:
              original: '100.00'
              modalidadeAlteracao: 0
            chave: 40a0932d-1918-4eee-845d-35a2da1690dc
            solicitacaoPagador: Informar cartão fidelidade
            pix:
              - endToEndId: E12345678202009091221kkkkkkkkkkk
                txid: 655dfdb1a4514b8fbb58254b958913fb
                valor: '110.00'
                horario: '2020-09-09T20:15:00.358Z'
                infoPagador: '0123456789'
                devolucoes:
                  - id: 123ABC
                    rtrId: Dxxxxxxxx202009091221kkkkkkkkkkk
                    valor: '10.00'
                    horario:
                      solicitacao: '2020-09-09T20:15:00.358Z'
                    status: EM_PROCESSAMENTO
          - calendario:
              criacao: '2020-09-09T20:15:00.358Z'
              expiracao: 3600
            txid: 33beb661beda44a8928fef47dbeb2dc5
            revisao: 0
            loc:
              id: 1004
              txid: 33beb661beda44a8928fef47dbeb2dc5
              location: https://pix.example.com/qr/7faa6893c4e64893a503baf0d40af213
              tipoCob: cob
              criacao: '2020-09-09T20:15:00.358Z'
            location: https://pix.example.com/qr/7faa6893c4e64893a503baf0d40af213
            status: ATIVA
            devedor:
              cnpj: '12345678000195'
              nome: Empresa de Serviços SA
            valor:
              original: '0.00'
              modalidadeAlteracao: 0
              retirada:
                saque:
                  valor: '5.00'
                  modalidadeAlteracao: 0
                  modalidadeAgente: AGPSS
                  prestadorDoServicoDeSaque: '12345678'
            chave: 7d9f0335-8dcc-4054-9bf9-0dbd61d36906
          - calendario:
              criacao: '2020-09-09T20:15:00.358Z'
              expiracao: 3600
            txid: 33beb661beda44a8928fef47dbeb2dc5
            revisao: 0
            loc:
              id: 1004
              txid: 33beb661beda44a8928fef47dbeb2dc5
              location: https://pix.example.com/qr/7faa6893c4e64893a503baf0d40af213
              tipoCob: cob
              criacao: '2020-09-09T20:15:00.358Z'
            location: https://pix.example.com/qr/7faa6893c4e64893a503baf0d40af213
            status: ATIVA
            devedor:
              cnpj: '12345678000195'
              nome: Empresa de Serviços SA
            valor:
              original: '0.00'
              modalidadeAlteracao: 0
              retirada:
                saque:
                  valor: '20.00'
                  modalidadeAlteracao: 1
                  modalidadeAgente: AGPSS
                  prestadorDoServicoDeSaque: '12345678'
            chave: 7d9f0335-8dcc-4054-9bf9-0dbd61d36906
          - calendario:
              criacao: '2020-09-09T20:15:00.358Z'
              expiracao: 3600
            txid: 33beb661beda44a8928fef47dbeb2dc5
            revisao: 0
            loc:
              id: 1004
              txid: 33beb661beda44a8928fef47dbeb2dc5
              criacao: '2020-09-09T20:15:00.358Z'
              location: https://pix.example.com/qr/7faa6893c4e64893a503baf0d40af213
              tipoCob: cob
            location: https://pix.example.com/qr/7faa6893c4e64893a503baf0d40af213
            status: ATIVA
            devedor:
              cnpj: '12345678000195'
              nome: Empresa de Serviços SA
            valor:
              original: '10.00'
              modalidadeAlteracao: 0
              retirada:
                troco:
                  valor: '0.00'
                  modalidadeAlteracao: 1
                  modalidadeAgente: AGTEC
                  prestadorDoServicoDeSaque: '12345678'
            chave: 7d9f0335-8dcc-4054-9bf9-0dbd61d36906
    getCobs2:
      summary: Exemplo de retorno da consulta de cobranças 2
      value:
        parametros:
          inicio: '2020-04-01T00:00:00Z'
          fim: '2020-04-01T23:59:59Z'
          paginacao:
            paginaAtual: 0
            itensPorPagina: 99
            quantidadeDePaginas: 1
            quantidadeTotalDeItens: 1
        cobs:
          - calendario:
              criacao: '2020-09-09T20:15:00.358Z'
              expiracao: 3600
            txid: 7978c0c97ea847e78e8849634473c1f1
            revisao: 0
            loc:
              id: 789
              txid: 7978c0c97ea847e78e8849634473c1f1
              location: https://pix.example.com/qr/9d36b84fc70b478fb95c12729b90ca25
              tipoCob: cob
              criacao: '2020-09-09T20:15:00.358Z'
            location: https://pix.example.com/qr/9d36b84fc70b478fb95c12729b90ca25
            status: ATIVA
            devedor:
              cnpj: '12345678000195'
              nome: Empresa de Serviços SA
            valor:
              original: '37.00'
              modalidadeAlteracao: 1
            chave: 7d9f0335-8dcc-4054-9bf9-0dbd61d36906
            solicitacaoPagador: Serviço realizado.
            infoAdicionais:
              - nome: Campo 1
                valor: Informação Adicional1 do PSP-Recebedor
              - nome: Campo 2
                valor: Informação Adicional2 do PSP-Recebedor
    RequisicaoInvalidaCobListExample1:
      summary: Exemplo de erro da requisição 1
      value:
        type: https://pix.bcb.gov.br/api/v2/error/CobOperacaoInvalida
        title: Requisição invalida.
        status: 400
        detail: A requisição não respeita o _schema_ ou está semanticamente errada.
        violacoes:
          - razao: O campo inicio não respeita o _schema_.
            propriedade: inicio
    cobResponse4:
      summary: Exemplo de cobrança com vencimento 1
      value:
        calendario:
          criacao: '2020-09-09T20:15:00.358Z'
          dataDeVencimento: '2020-12-31'
          validadeAposVencimento: 30
        txid: 7978c0c97ea847e78e8849634473c1f1
        revisao: 0
        loc:
          id: 789
          txid: 7978c0c97ea847e78e8849634473c1f1
          location: https://pix.example.com/qr/c2/cobv/9d36b84fc70b478fb95c12729b90ca25
          tipoCob: cobv
          criacao: '2020-09-09T20:15:00.358Z'
        status: ATIVA
        devedor:
          logradouro: Alameda Souza, Numero 80, Bairro Braz
          cidade: Recife
          uf: PE
          cep: '70011750'
          cpf: '12345678909'
          nome: Francisco da Silva
        recebedor:
          logradouro: Rua 15 Numero 1200, Bairro São Luiz
          cidade: São Paulo
          uf: SP
          cep: '70800100'
          cnpj: '56989000019533'
          nome: Empresa de Logística SA
        valor:
          original: '123.45'
        chave: 5f84a4c5-c5cb-4599-9f13-7eb4d419dacc
        solicitacaoPagador: Cobrança dos serviços prestados.
    RequisicaoInvalidaCobVGetExample1:
      summary: Exemplo de erro da requisição 1
      value:
        type: https://pix.bcb.gov.br/api/v2/error/CobVOperacaoInvalida
        title: Requisição invalida.
        status: 400
        detail: A requisição não respeita o _schema_ ou está semanticamente errada.
        violacoes:
          - razao: O campo txid não respeita o _schema_.
            propriedade: txid
    cobBody1:
      summary: Exemplo de criação de cobrança com vencimento 1
      value:
        calendario:
          dataDeVencimento: '2020-12-31'
          validadeAposVencimento: 30
        loc:
          id: 789
        devedor:
          logradouro: Alameda Souza, Numero 80, Bairro Braz
          cidade: Recife
          uf: PE
          cep: '70011750'
          cpf: '12345678909'
          nome: Francisco da Silva
        valor:
          original: '123.45'
          multa:
            modalidade: 2
            valorPerc: '15.00'
          juros:
            modalidade: 2
            valorPerc: '2.00'
          desconto:
            modalidade: 1
            descontoDataFixa:
              - data: '2020-11-30'
                valorPerc: '30.00'
        chave: 5f84a4c5-c5cb-4599-9f13-7eb4d419dacc
        solicitacaoPagador: Cobrança dos serviços prestados.
    OperacaoInvalidaCobVExample1:
      summary: Exemplo de erro da requisição 1
      value:
        type: https://pix.bcb.gov.br/api/v2/error/CobVOperacaoInvalida
        title: Operacao invalida.
        status: 400
        detail: Cobrança não encontra-se mais com o status ATIVA, somente cobranças ativas podem ser revisadas.
    cobBody7:
      summary: Exemplo de revisão de cobrança com vencimento 1
      value:
        loc:
          id: 789
        devedor:
          logradouro: Alameda Souza, Numero 80, Bairro Braz
          cidade: Recife
          uf: PE
          cep: '70011750'
          cpf: '12345678909'
          nome: Francisco da Silva
        valor:
          original: '123.45'
        solicitacaoPagador: Cobrança dos serviços prestados.
    getCobsV1:
      summary: Exemplo de retorno da consulta de cobranças com vencimento 1
      value:
        parametros:
          inicio: '2020-04-01T00:00:00Z'
          fim: '2020-04-01T23:59:59Z'
          paginacao:
            paginaAtual: 0
            itensPorPagina: 99
            quantidadeDePaginas: 1
            quantidadeTotalDeItens: 1
        cobs:
          - calendario:
              criacao: '2020-09-09T20:15:00.358Z'
              dataDeVencimento: '2020-12-31'
              validadeAposVencimento: 30
            txid: 7978c0c97ea847e78e8849634473c1f1
            revisao: 0
            loc:
              id: 789
              txid: 7978c0c97ea847e78e8849634473c1f1
              location: https://pix.example.com/qr/c2/cobv/9d36b84fc70b478fb95c12729b90ca25
              tipoCob: cobv
              criacao: '2020-09-09T20:15:00.358Z'
            status: ATIVA
            devedor:
              logradouro: Alameda Souza, Numero 80, Bairro Braz
              cidade: Recife
              uf: PE
              cep: '70011750'
              cpf: '12345678909'
              nome: Francisco da Silva
            recebedor:
              logradouro: Rua 15 Numero 1200, Bairro São Luiz
              cidade: São Paulo
              uf: SP
              cep: '70800100'
              cnpj: '56989000019533'
              nome: Empresa de Logística SA
            valor:
              original: '123.45'
            chave: 5f84a4c5-c5cb-4599-9f13-7eb4d419dacc
            solicitacaoPagador: Cobrança dos serviços prestados.
    RequisicaoInvalidaCobVListExample1:
      summary: Exemplo de erro da requisição 1
      value:
        type: https://pix.bcb.gov.br/api/v2/error/CobVOperacaoInvalida
        title: Requisição invalida.
        status: 400
        detail: A requisição não respeita o _schema_ ou está semanticamente errada.
        violacoes:
          - razao: O campo inicio não respeita o _schema_.
            propriedade: inicio
    getPayloadLocation1:
      summary: Exemplo de retorno da consulta de locations 1
      value:
        parametros:
          inicio: '2020-04-01T00:00:00Z'
          fim: '2020-04-01T23:59:59Z'
          paginacao:
            paginaAtual: 0
            itensPorPagina: 99
            quantidadeDePaginas: 1
            quantidadeTotalDeItens: 3
        loc:
          - id: 7716
            txid: fda9460fe04e4f129b72863ae57ee22f
            location: https://pix.example.com/qr/v2/cobv/2353c790eefb11eaadc10242ac120002
            tipoCob: cobv
            criacao: '2020-03-11T21:19:51.013Z'
          - id: 856
            txid: 31e08604f9ce459bb59672332af8d672
            location: https://pix.example.com/qr/v2/cobv/39c9f435c6324867aa1dec1260e1127c
            tipoCob: cobv
            criacao: '2020-02-10T19:22:52.013Z'
          - id: 2316
            txid: eb9d87f36fca4c92b7d5ec48e2ee3853
            location: https://pix.example.com/qr/v2/a8534e273ecb47d3ac30613104544466
            tipoCob: cob
            criacao: '2020-05-31T19:39:54.013Z'
    RequisicaoInvalidaLocationListExample1:
      summary: Exemplo de erro da requisição 1
      value:
        type: https://pix.bcb.gov.br/api/v2/error/PayloadLocationOperacaoInvalida
        title: PayloadLocation invalido.
        status: 400
        detail: A requisição não respeita o _schema_ ou está semanticamente errada.
        violacoes:
          - razao: O campo inicio não respeita o _schema_.
            propriedade: inicio
    payloadLocationBody1:
      summary: Exemplo de Payload Location 1
      value:
        tipoCob: cob
    payloadLocationBody2:
      summary: Exemplo de Payload Location 2
      value:
        tipoCob: cobv
    payloadLocationResponse5:
      summary: Exemplo de Payload Location 1
      value:
        id: 7716
        location: https://pix.example.com/qr/v2/2353c790eefb11eaadc10242ac120002
        tipoCob: cob
        criacao: '2020-03-11T21:19:51.013Z'
    payloadLocationResponse6:
      summary: Exemplo de Payload Location 2
      value:
        id: 856
        location: https://pix.example.com/qr/v2/cobv/39c9f435c6324867aa1dec1260e1127c
        tipoCob: cobv
        criacao: '2020-02-10T19:22:52.013Z'
    RequisicaoInvalidaLocationExample1:
      summary: Exemplo de erro da requisição 1
      value:
        type: https://pix.bcb.gov.br/api/v2/error/PayloadLocationOperacaoInvalida
        title: PayloadLocation invalido.
        status: 400
        detail: A presente requisição busca criar uma location sem respeitar o _schema_ estabelecido.
    payloadLocationResponse1:
      summary: Exemplo de Payload Location 1
      value:
        id: 7716
        txid: fda9460fe04e4f129b72863ae57ee22f
        location: https://pix.example.com/qr/v2/cobv/2353c790eefb11eaadc10242ac120002
        tipoCob: cobv
        criacao: '2020-03-11T21:19:51.013Z'
    payloadLocationResponse2:
      summary: Exemplo de Payload Location 2
      value:
        id: 856
        txid: 31e08604f9ce459bb59672332af8d672
        location: https://pix.example.com/qr/v2/cobv/39c9f435c6324867aa1dec1260e1127c
        tipoCob: cobv
        criacao: '2020-02-10T19:22:52.013Z'
    payloadLocationResponse3:
      summary: Exemplo de Payload Location 3
      value:
        id: 2316
        txid: eb9d87f36fca4c92b7d5ec48e2ee3853
        location: https://pix.example.com/qr/v2/a8534e273ecb47d3ac30613104544466
        tipoCob: cob
        criacao: '2020-05-31T19:39:54.013Z'
    RequisicaoInvalidaLocationGetExample1:
      summary: Exemplo de erro da requisição 1
      value:
        type: https://pix.bcb.gov.br/api/v2/error/PayloadLocationOperacaoInvalida
        title: PayloadLocation invalido.
        status: 400
        detail: A requisição não respeita o _schema_ ou está semanticamente errada.
        violacoes:
          - razao: O campo id não respeita o _schema_.
            propriedade: id
    payloadLocationResponse4:
      summary: Exemplo de Payload Location 3
      value:
        id: 2316
        location: https://pix.example.com/qr/v2/a8534e273ecb47d3ac30613104544466
        tipoCob: cob
        criacao: '2020-05-31T19:39:54.013Z'
  responses:
    RequisicaoInvalidaCobGet:
      description: Problemas na requisição.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problema'
          examples:
            exemplo1:
              $ref: '#/components/examples/RequisicaoInvalidaCobGetExample1'
    AcessoNegado:
      description: Requisição de participante autenticado que viola alguma regra de autorização.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problema'
          examples:
            exemplo1:
              $ref: '#/components/examples/AcessoNegadoExample1'
    NaoEncontrado:
      description: Recurso solicitado não foi encontrado.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problema'
          examples:
            exemplo1:
              $ref: '#/components/examples/NaoEncontradoExample1'
    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.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problema'
          examples:
            exemplo1:
              $ref: '#/components/examples/ServicoIndisponivelExample1'
    RequisicaoInvalidaCob:
      description: Problemas na requisição.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problema'
          examples:
            exemplo1:
              $ref: '#/components/examples/RequisicaoInvalidaCobExample1'
    RequisicaoInvalidaCobList:
      description: Problemas na requisição.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problema'
          examples:
            exemplo1:
              $ref: '#/components/examples/RequisicaoInvalidaCobListExample1'
    RequisicaoInvalidaCobVGet:
      description: Problemas na requisição.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problema'
          examples:
            exemplo1:
              $ref: '#/components/examples/RequisicaoInvalidaCobVGetExample1'
    RequisicaoInvalidaCobV:
      description: Problemas na requisição.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problema'
          examples:
            exemplo1:
              $ref: '#/components/examples/OperacaoInvalidaCobVExample1'
    RequisicaoInvalidaCobVList:
      description: Problemas na requisição.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problema'
          examples:
            exemplo1:
              $ref: '#/components/examples/RequisicaoInvalidaCobVListExample1'
    RequisicaoInvalidaLocationList:
      description: Problemas na requisição.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problema'
          examples:
            exemplo1:
              $ref: '#/components/examples/RequisicaoInvalidaLocationListExample1'
    RequisicaoInvalidaLocation:
      description: Problemas na requisição.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problema'
          examples:
            exemplo1:
              $ref: '#/components/examples/RequisicaoInvalidaLocationExample1'
    RequisicaoInvalidaLocationGet:
      description: Problemas na requisição.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problema'
          examples:
            exemplo1:
              $ref: '#/components/examples/RequisicaoInvalidaLocationGetExample1'
  requestBodies:
    CobBody:
      description: Dados para geração da cobrança imediata.
      required: true
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/CobSolicitada'
          examples:
            exemplo1:
              $ref: '#/components/examples/cobBody2'
            exemplo2:
              $ref: '#/components/examples/cobBody6'
            exemplo3:
              $ref: '#/components/examples/cobBody8'
            exemplo4:
              $ref: '#/components/examples/cobBody9'
    CobBodyRevisada:
      description: Dados para geração da cobrança.
      required: true
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/CobRevisada'
          examples:
            exemplo1:
              $ref: '#/components/examples/cobBody3'
            exemplo2:
              $ref: '#/components/examples/cobBody4'
            exemplo3:
              $ref: '#/components/examples/cobBody5'
    CobVBody:
      description: Dados para geração da cobrança com vencimento.
      required: true
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/CobVSolicitada'
          examples:
            exemplo1:
              $ref: '#/components/examples/cobBody1'
    CobVBodyRevisada:
      description: Dados para geração da cobrança.
      required: true
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/CobVRevisada'
          examples:
            exemplo1:
              $ref: '#/components/examples/cobBody7'
            exemplo2:
              $ref: '#/components/examples/cobBody4'
            exemplo3:
              $ref: '#/components/examples/cobBody5'
    PayloadLocationBody:
      description: Dados para geração da location.
      required: true
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PayloadLocationSolicitada'
          examples:
            exemplo1:
              $ref: '#/components/examples/payloadLocationBody1'
            exemplo2:
              $ref: '#/components/examples/payloadLocationBody2'
x-jpmc-securityDefinitions:
  MutualTLS:
    type: x509
    description: Mutual TLS authentication using client and server certificates.
x-jpmc-security:
  - MutualTLS
```