From f41532958c3bd2d52795923ebe404a87c5bfcc87 Mon Sep 17 00:00:00 2001 From: Thiago Luiz Vieira de Lima Santos Date: Fri, 29 Oct 2021 14:39:28 -0300 Subject: [PATCH] release 2.6.1 --- changelog.md | 153 ++++++++++++++++++++++++++++----------------------- openapi.yaml | 92 ++++++++++++++++++++----------- readme.md | 4 +- 3 files changed, 144 insertions(+), 105 deletions(-) diff --git a/changelog.md b/changelog.md index 90f8157..7d37543 100644 --- a/changelog.md +++ b/changelog.md @@ -1,90 +1,101 @@ # Changelog Mudanças relevantes na API Pix serão documentadas aqui neste documento. -## [2.6.0] -* Inclusão e referenciamento de "Status do registro de cobrança" onde lia-se "Status da Cobrança" com a descrição da semântica de cada estado. -* Inclusão do campo `pixCopiaECola` (opcional) correspondente às cobranças. -* Na listagem `componentesValor` do objeto `Pix` foram incluídas as informações relativas aos juros, multas, descontos e abatimentos quando o Pix se refere a um pagamento de cobrança com vencimento. Tendo assim o detalhamento em caso de antecipações ou atrasos no pagamento. -* Inclusão do campo `descricao` nos objetos que tratam de Devoluções. -* Ajuste na descrição do campo `natureza` nas Devoluções. - + +## [2.6.1] + +- Restrição da `modalidadeAgente` do Pix Troco para aceitar somente `AGTEC`. +- Ajustes nos endpoints de Devolução para os diferentes tipos de natureza relacionados aos códigos `BE08` e `FR01`. +- Indicação tamanho máximo do campo `pixCopiaECola` [[#457](https://github.com/bacen/pix-api/issues/457)]. + +## [2.6.0] + +- Inclusão e referenciamento de "Status do registro de cobrança" onde lia-se "Status da Cobrança" com a descrição da semântica de cada estado. +- Inclusão do campo `pixCopiaECola` (opcional) correspondente às cobranças. +- Na listagem `componentesValor` do objeto `Pix` foram incluídas as informações relativas aos juros, multas, descontos e abatimentos quando o Pix se refere a um pagamento de cobrança com vencimento. Tendo assim o detalhamento em caso de antecipações ou atrasos no pagamento. +- Inclusão do campo `descricao` nos objetos que tratam de Devoluções. +- Ajuste na descrição do campo `natureza` nas Devoluções. + ## [2.5.0] -* Inclusão do atributo `retirada` como campo opcional do objeto `valor` nos endpoints de consulta, criação e revisão da cobrança imediata. O campo pode ser preenchido com os atributos `saque` ou `troco` exclusivamente, detalhados pelos atributos `valor` e `modalidadeAlteracao`. Se apresentarem o campo `modalidadeAlteracao` como valor 1, significa que o usuário pagador pode alterar o valor do saque ou troco. -Em sua ausência, assume-se o valor 0, que significa que o valor do saque ou troco não pode ser alterado. -* Inclusão do atributo `componentesValor` como campo opcional nos endpoints de consulta Pix para informações da composição do valor final do Pix, este será detalhado por um array de objetos compostos por `tipo` e `valor`. -* Formatações gerais de referências a campos, objetos e schemas. -* Inclusão do domínio `natureza` nas devoluções para diferenciamento de devoluções de Pix comuns, ou oriundos de Saque/Troco. -* Referências a https://www.bcb.gov.br/estabilidadefinanceira/pagamentosinstantaneos trocadas por https://www.bcb.gov.br/estabilidadefinanceira/pix. + +- Inclusão do atributo `retirada` como campo opcional do objeto `valor` nos endpoints de consulta, criação e revisão da cobrança imediata. O campo pode ser preenchido com os atributos `saque` ou `troco` exclusivamente, detalhados pelos atributos `valor` e `modalidadeAlteracao`. Se apresentarem o campo `modalidadeAlteracao` como valor 1, significa que o usuário pagador pode alterar o valor do saque ou troco. + Em sua ausência, assume-se o valor 0, que significa que o valor do saque ou troco não pode ser alterado. +- Inclusão do atributo `componentesValor` como campo opcional nos endpoints de consulta Pix para informações da composição do valor final do Pix, este será detalhado por um array de objetos compostos por `tipo` e `valor`. +- Formatações gerais de referências a campos, objetos e schemas. +- Inclusão do domínio `natureza` nas devoluções para diferenciamento de devoluções de Pix comuns, ou oriundos de Saque/Troco. +- Referências a https://www.bcb.gov.br/estabilidadefinanceira/pagamentosinstantaneos trocadas por https://www.bcb.gov.br/estabilidadefinanceira/pix. ## [2.4.0] -* Não houve mudança. Versão seguiu para 2.5.0 para acompanhar o Manual de Iniciação. - + +- Não houve mudança. Versão seguiu para 2.5.0 para acompanhar o Manual de Iniciação. + ## [2.3.0] -* `modalidadeAlteracao` agora é um campo opcional do objeto `valor` -no payload da cobrança imediata e nos endpoints de criação e revisão da cobrança imediata. -Se apresentado como valor 1, significa que o usuário pagador pode alterar o valor da cobrança. -Em sua ausência, assume-se o valor 0, que significa que a cobrança não pode ser alterada. -* Não é mais obrigatório que o fragmento de versão v2 esteja presente na _location_. -Não há problema em manter o fragmento; este será considerado como parte integrante da _location_. -* [[#348](https://github.com/bacen/pix-api/issues/348)]: corrige case do padrão de datas de `yyyy-mm-dd` -> `YYYY-MM-DD`. -* [[#354](https://github.com/bacen/pix-api/issues/354)]: Aprimora a descrição do webhook detalhando -a ativação em caso de devolução de um pix. O callback deve ser ativado, também, no caso de serem atingidos -os status finais da devolução: "devolvido" e "não realizado". -* [[#356](https://github.com/bacen/pix-api/issues/356)]: Adiciona dois cenários de erro para o endpoint -`PUT /pix/{e2eid}/devolucao/{id}` na seção de tratamentos de erros. -* [[#357](https://github.com/bacen/pix-api/issues/357)]: aprimora a descrição do campo "motivo" no retorno do endpoint -`​/pix​/{e2eid}​/devolucao​/{id}`. + +- `modalidadeAlteracao` agora é um campo opcional do objeto `valor` + no payload da cobrança imediata e nos endpoints de criação e revisão da cobrança imediata. + Se apresentado como valor 1, significa que o usuário pagador pode alterar o valor da cobrança. + Em sua ausência, assume-se o valor 0, que significa que a cobrança não pode ser alterada. +- Não é mais obrigatório que o fragmento de versão v2 esteja presente na _location_. + Não há problema em manter o fragmento; este será considerado como parte integrante da _location_. +- [[#348](https://github.com/bacen/pix-api/issues/348)]: corrige case do padrão de datas de `yyyy-mm-dd` -> `YYYY-MM-DD`. +- [[#354](https://github.com/bacen/pix-api/issues/354)]: Aprimora a descrição do webhook detalhando + a ativação em caso de devolução de um pix. O callback deve ser ativado, também, no caso de serem atingidos + os status finais da devolução: "devolvido" e "não realizado". +- [[#356](https://github.com/bacen/pix-api/issues/356)]: Adiciona dois cenários de erro para o endpoint + `PUT /pix/{e2eid}/devolucao/{id}` na seção de tratamentos de erros. +- [[#357](https://github.com/bacen/pix-api/issues/357)]: aprimora a descrição do campo "motivo" no retorno do endpoint + `​/pix​/{e2eid}​/devolucao​/{id}`. ## [2.2.2] -* [[#331](https://github.com/bacen/pix-api/issues/331)]: O campo `validadeAposVencimento` estava constando como `opcional`, na resposta da criação da cobrança, um efeito colateral da correção correlata ocorrida na release 2.2.1. -* [[#334](https://github.com/bacen/pix-api/issues/334)]: adicionados detalhes a respeito da manipulação da revisão da cobrança em cenário de alteração do _location_. -* [[#342](https://github.com/bacen/pix-api/issues/342)]: removidos trechos duplicados na seção de tratamento de erros. +- [[#331](https://github.com/bacen/pix-api/issues/331)]: O campo `validadeAposVencimento` estava constando como `opcional`, na resposta da criação da cobrança, um efeito colateral da correção correlata ocorrida na release 2.2.1. +- [[#334](https://github.com/bacen/pix-api/issues/334)]: adicionados detalhes a respeito da manipulação da revisão da cobrança em cenário de alteração do _location_. +- [[#342](https://github.com/bacen/pix-api/issues/342)]: removidos trechos duplicados na seção de tratamento de erros. ## [2.2.1] ### Corrigido: -* Os campos no objeto "devedor" no request do endpoint `PUT /cobv/{txid}` passam a ser opcionais. -Nem sempre o usuário recebedor tem a posse de todas as informações que constavam como obrigatórias. -* [[#307](https://github.com/bacen/pix-api/issues/307)]: Detalhada a semântica do campo `validadeAposVencimento`. Passa a apresentar redação -detalhando o que ocorre em casos de exceção em que o vencimento da cobrança seja um final de semana -ou um feriado juntamente com a atribuição de um valor pequeno para `validadeAposVencimento`. -* O campo `validadeAposVencimento` estava constando como `required`, o que estava incorreto. -Quando não preenchido, o PSP recebedor assume o valor deste campo como 30, então não há motivos para -o campo ser obrigatório. -* [[#269](https://github.com/bacen/pix-api/issues/269)]. A regex do txid, na parte concernente ao tamanho, nos endpoints /pix e no callback webhook, -estava errada. Corrigida de `{26,35}` para `{1,35}` porque pode haver a presença de pagamentos de QRs -estáticos nesses locais. -* [[#270](https://github.com/bacen/pix-api/issues/270)]: O id do objeto `location` estava especificado como `int32`. De fato, apenas cerca de 2 bilhões -de possibilidades pode acabar muito rápido para grandes emissores de cobranças. Entendemos que o identificador do objeto `lotecobv` -se encaixa na mesma situação. Nesse sentido, alteramos de `int32` para `int64`, -o que não deve causar maiores problemas no momento. -* [[#249](github.com/bacen/pix-api/issues/249)], [[#250](github.com/bacen/pix-api/issues/250)]: Com a entrada do campo "chave" como identificador do webhook, toda a parte referente à paginação -em GET /webhook perde a razão de existir. Nesse sentido, os parâmetros de busca "inicio" e "fim" passam -a ser opcionais. O objeto de paginação "parametros", também torna-se opcional. -* [[#239](github.com/bacen/pix-api/issues/239)]: Conforme relatado nesta discussão, entendemos que -seria interessante, tanto sob o aspecto de segurança quanto sob o aspecto de funcionalidade, que o -objeto pix agregue o atributo "chave", opcional. -* [[#241](https://github.com/bacen/pix-api/issues/241)]: Acrescentamos detalhes em relação à questão do acionamento do webhook por parte do PSP recebedor. -* [[#294](https://github.com/bacen/pix-api/issues/294)]: Erro de ortografia. Na documentação, onde se lê `pixUrlAcessToken` deveria estar escrito `pixUrlAccessToken`. -* [[#273](https://github.com/bacen/pix-api/issues/273)]: O texto do response 202 do endpoint `PATCH lotecobv/{id}` estava erroneamente induzindo o -leitor a pensar que o lote já estava revisado quando, na verdade, estaria apenas em processamento -* [[#273](https://github.com/bacen/pix-api/issues/273)]: Na lista de violações em lotecobv, havia indicações do endpoint `/lotecobv/{txid}`, o que inexiste. O correto é `/lotecobv/{id}`. -* [[#316](https://github.com/bacen/pix-api/issues/316)]: Duas violações específicas foram removidas por questões de performance. +- Os campos no objeto "devedor" no request do endpoint `PUT /cobv/{txid}` passam a ser opcionais. + Nem sempre o usuário recebedor tem a posse de todas as informações que constavam como obrigatórias. +- [[#307](https://github.com/bacen/pix-api/issues/307)]: Detalhada a semântica do campo `validadeAposVencimento`. Passa a apresentar redação + detalhando o que ocorre em casos de exceção em que o vencimento da cobrança seja um final de semana + ou um feriado juntamente com a atribuição de um valor pequeno para `validadeAposVencimento`. +- O campo `validadeAposVencimento` estava constando como `required`, o que estava incorreto. + Quando não preenchido, o PSP recebedor assume o valor deste campo como 30, então não há motivos para + o campo ser obrigatório. +- [[#269](https://github.com/bacen/pix-api/issues/269)]. A regex do txid, na parte concernente ao tamanho, nos endpoints /pix e no callback webhook, + estava errada. Corrigida de `{26,35}` para `{1,35}` porque pode haver a presença de pagamentos de QRs + estáticos nesses locais. +- [[#270](https://github.com/bacen/pix-api/issues/270)]: O id do objeto `location` estava especificado como `int32`. De fato, apenas cerca de 2 bilhões + de possibilidades pode acabar muito rápido para grandes emissores de cobranças. Entendemos que o identificador do objeto `lotecobv` + se encaixa na mesma situação. Nesse sentido, alteramos de `int32` para `int64`, + o que não deve causar maiores problemas no momento. +- [[#249](github.com/bacen/pix-api/issues/249)], [[#250](github.com/bacen/pix-api/issues/250)]: Com a entrada do campo "chave" como identificador do webhook, toda a parte referente à paginação + em GET /webhook perde a razão de existir. Nesse sentido, os parâmetros de busca "inicio" e "fim" passam + a ser opcionais. O objeto de paginação "parametros", também torna-se opcional. +- [[#239](github.com/bacen/pix-api/issues/239)]: Conforme relatado nesta discussão, entendemos que + seria interessante, tanto sob o aspecto de segurança quanto sob o aspecto de funcionalidade, que o + objeto pix agregue o atributo "chave", opcional. +- [[#241](https://github.com/bacen/pix-api/issues/241)]: Acrescentamos detalhes em relação à questão do acionamento do webhook por parte do PSP recebedor. +- [[#294](https://github.com/bacen/pix-api/issues/294)]: Erro de ortografia. Na documentação, onde se lê `pixUrlAcessToken` deveria estar escrito `pixUrlAccessToken`. +- [[#273](https://github.com/bacen/pix-api/issues/273)]: O texto do response 202 do endpoint `PATCH lotecobv/{id}` estava erroneamente induzindo o + leitor a pensar que o lote já estava revisado quando, na verdade, estaria apenas em processamento +- [[#273](https://github.com/bacen/pix-api/issues/273)]: Na lista de violações em lotecobv, havia indicações do endpoint `/lotecobv/{txid}`, o que inexiste. O correto é `/lotecobv/{id}`. +- [[#316](https://github.com/bacen/pix-api/issues/316)]: Duas violações específicas foram removidas por questões de performance. ## [2.2.0-rc.0] ### Adicionado: -- A API Pix agora estabelece uma série de erros padronizados seguindo a [RFC 7807](https://tools.ietf.org/html/rfc7807) reunidos na seção -"Tratamento de erros". Procuramos ser exaustivos com relação aos possíveis erros semânticos. -- Adicionado o endpoint `PATCH /lotecobv/{id}`. Este endpoint pode ser utilizado quando a intenção do -usuário recebedor for alterar cobranças específicas dentro do conjunto de cobranças criadas no lote em -questão. O endpoint `PUT /lotecobv/{id}` também pode ser utilizado para alterar cobranças, mas deve -ser atribuído na requisição o array exatamente como especificado na requisição originária, o que torna -este endpoint ineficiente no caso em que quer se alterar uma cobrança específica ou poucas dentro de um -array com grande quantidade de cobranças. +- A API Pix agora estabelece uma série de erros padronizados seguindo a [RFC 7807](https://tools.ietf.org/html/rfc7807) reunidos na seção + "Tratamento de erros". Procuramos ser exaustivos com relação aos possíveis erros semânticos. +- Adicionado o endpoint `PATCH /lotecobv/{id}`. Este endpoint pode ser utilizado quando a intenção do + usuário recebedor for alterar cobranças específicas dentro do conjunto de cobranças criadas no lote em + questão. O endpoint `PUT /lotecobv/{id}` também pode ser utilizado para alterar cobranças, mas deve + ser atribuído na requisição o array exatamente como especificado na requisição originária, o que torna + este endpoint ineficiente no caso em que quer se alterar uma cobrança específica ou poucas dentro de um + array com grande quantidade de cobranças. - Incorporadas melhorias de redação em alguns endpoints específicos. @@ -119,7 +130,7 @@ array com grande quantidade de cobranças. ### Correções -- removido o objeto __opcional__ pix.pagador [#153](https://github.com/bacen/pix-api/issues/153) +- removido o objeto **opcional** pix.pagador [#153](https://github.com/bacen/pix-api/issues/153) - os webhooks agora são associados a uma chave pix [#120](https://github.com/bacen/pix-api/issues/120) - os endereços dos endpoints agora apresentam corretamente o fragmento `v2` [#3](https://github.com/bacen/pix-api/issues/3) @@ -147,7 +158,7 @@ array com grande quantidade de cobranças. - corrigido exemplo JWS da tag cobPayload -## [2.1.0-rc.0] +## [2.1.0-rc.0] ### Novidades @@ -162,9 +173,10 @@ array com grande quantidade de cobranças. - API começa em v2 e acompanha a major version [#3](https://github.com/bacen/pix-api/issues/3) - revisados exemplos inconsistentes. -## [2.0.0] +## [2.0.0] ### Adicionado + - Endpoint para criação de Cobranças - Endpoint para gerenciamento de Cobranças - Endpoint para consulta parametrizada de Cobranças @@ -179,6 +191,7 @@ array com grande quantidade de cobranças. - Autenticação e Autorização baseada em OAuth2 ### Removido + - Recursos para gerenciamento de Documentos - Configuração de vencimento em calendário - Configuração de juros, multa e desconto em valor diff --git a/openapi.yaml b/openapi.yaml index 860d99f..dce76ca 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -1,7 +1,7 @@ openapi: 3.0.0 info: title: API Pix - version: "2.6.0" + version: "2.6.1" license: name: Apache 2.0 url: http://www.apache.org/licenses/LICENSE-2.0 @@ -1322,7 +1322,7 @@ paths: security: - OAuth2: [pix.write] description: | - Endpoint para solicitar uma devolução através de um e2eid do Pix e do ID da devolução. O motivo que será atribuído à PACS.004 será "Devolução solicitada pelo usuário recebedor do pagamento original" cuja sigla é "MD06" de acordo com a aba RTReason da PACS.004 que consta no Catálogo de Mensagens do Pix. + Endpoint para solicitar uma devolução através de um e2eid do Pix e do ID da devolução. O motivo que será atribuído à PACS.004 será "MD06" ou "SL02" de acordo com a aba RTReason da PACS.004 que consta no Catálogo de Mensagens do Pix a depender da `natureza` da devolução (Vide a descrição deste campo). requestBody: $ref: "#/components/requestBodies/DevolucaoBody" responses: @@ -1807,7 +1807,7 @@ components: troco: valor: "0.00" modalidadeAlteracao: 1 - modalidadeAgente: "AGPSS" + modalidadeAgente: "AGTEC" prestadorDoServicoDeSaque: "12345678" chave: "7d9f0335-8dcc-4054-9bf9-0dbd61d36906" loteCobVBody1: @@ -2056,7 +2056,7 @@ components: troco: valor: "0.00" modalidadeAlteracao: 1 - modalidadeAgente: "AGPSS" + modalidadeAgente: "AGTEC" prestadorDoServicoDeSaque: "12345678" chave: "7d9f0335-8dcc-4054-9bf9-0dbd61d36906" loteCobVResponse1: @@ -2679,27 +2679,54 @@ components: title: "Id da Devolução" description: "Id gerado pelo cliente para representar unicamente uma devolução." pattern: "[a-zA-Z0-9]{1,35}" + DevolucaoSolicitadaNatureza: + type: "string" + title: "Natureza da Devolução Solicitada" + description: | + Indica qual é a natureza da devolução solicitada. Uma solicitação de devolução pelo usuário recebedor pode ser relacionada a um Pix + comum (com código: `MD06` da pacs.004), ou 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 sendo de um Pix comum (`ORIGINAL`). + + As naturezas são assim definidas: + - `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`); + - `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`). + + Os valores de devoluções são sempre limitados aos valores máximos a seguir: + - Pix comum: o valor da devolução é limitado ao valor do próprio Pix (a natureza nesse caso deve ser: ORIGINAL); + - Pix Saque: o valor da devolução é limitado ao valor da retirada (a natureza nesse caso deve ser: RETIRADA); e + - Pix Troco: o valor da devolução é limitado ao valor relativo à compra ou ao troco: + - Quando a devolução for referente à compra, o valor limita-se ao valor da compra (a natureza nesse caso deve ser ORIGINAL); e + - Quando a devolução for referente ao troco, o valor limita-se ao valor do troco (a natureza nesse caso deve ser RETIRADA). + + enum: + - "ORIGINAL" + - "RETIRADA" DevolucaoNatureza: type: "string" title: "Natureza da Devolução" description: | - Indica qual é a natureza da devolução. Uma devolução pode ser relacionada a um Pix comum (corresponde ao código `MD06` da pacs.004), - ou a um Pix de Saque ou Troco (corresponde ao código `SL02` da pacs.004). Na ausência deste campo a natureza deve ser interpretada - como sendo de um Pix comum (ORIGINAL). + 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), + ou 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 + sendo de um Pix comum (`ORIGINAL`). As naturezas são assim definidas: - - `ORIGINAL`: quando a devolução se refere a um Pix comum ou ao valor da compra em um Pix Troco; - - `RETIRADA`: quando a devolução se refere a um Pix Saque ou ao valor do troco em um Pix Troco. - - Os valores de devoluções são sempre limitados aos valores máximos de acordo com: - - Pix comum: o valor da devolução é limitado ao valor do próprio Pix (a natureza nesse caso é ORIGINAL); - - Pix Saque: o valor da devolução é limitado ao valor da retirada (a natureza nesse caso é RETIRADA); - - Pix Troco: o valor da devolução é limitado ao valor relativo à natureza da compra: - - ORIGINAL: limitado ao valor da compra; - - RETIRADA: limitado ao valor da retirada. + - `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`); + - `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`); + - `MED_OPERACIONAL`: quando a devolução ocorre no âmbito do MED por motivo de falha operacional e se refere a um Pix comum (`BE08`); + - `MED_FRAUDE`: quando a devolução ocorre no âmbito do MED por fundada suspeita de fraude e se refere a um Pix comum (`FR01`). + + Os valores de devoluções são sempre limitados aos valores máximos a seguir: + - 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); + - Pix Saque: o valor da devolução é limitado ao valor da retirada (a natureza nesse caso deve ser: RETIRADA); e + - Pix Troco: o valor da devolução é limitado ao valor relativo à compra ou ao troco: + - Quando a devolução for referente à compra, o valor limita-se ao valor da compra (a natureza nesse caso deve ser ORIGINAL); e + - Quando a devolução for referente ao troco, o valor limita-se ao valor do troco (a natureza nesse caso deve ser RETIRADA). + enum: - "ORIGINAL" - "RETIRADA" + - "MED_OPERACIONAL" + - "MED_FRAUDE" PayloadLocationId: type: "integer" format: "int64" @@ -3163,7 +3190,7 @@ components: 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. - Quando uma cobrança imediata tem uma estrutura de `retirada` ela deixa de ser considerada Pix comum e passa à categoria de Saque Pix. + Quando uma cobrança imediata tem uma estrutura de `retirada` ela deixa de ser considerada Pix comum e passa à categoria de Pix Saque ou Pix Troco. Para que o preenchimento do objeto `retirada` seja considerado válido as seguintes regras se aplicam: - os campos `modalidadeAgente` e `prestadorDoServicoDeSaque` são de **preenchimento obrigatório**; @@ -3233,7 +3260,7 @@ components: "retirada": { "troco": { "valor": "5.00", - "modalidadeAgente": "AGPSS", + "modalidadeAgente": "AGTEC", "prestadorDoServicoDeSaque": "12345678" } } @@ -3248,7 +3275,7 @@ components: "troco": { "valor": "0.00", "modalidadeAlteracao": 1, - "modalidadeAgente": "AGPSS", + "modalidadeAgente": "AGTEC", "prestadorDoServicoDeSaque": "12345678" } }, @@ -3282,7 +3309,7 @@ components: }, "troco": { "valor": "30.00", - "modalidadeAgente": "AGPSS", + "modalidadeAgente": "AGTEC", "prestadorDoServicoDeSaque": "12345678" } } @@ -3312,7 +3339,7 @@ components: "retirada": { "troco": { "valor": "5.00", - "modalidadeAgente": "AGPSS", + "modalidadeAgente": "AGTEC", "prestadorDoServicoDeSaque": "12345678" } } @@ -3420,11 +3447,9 @@ components: title: "Modalidade do Agente" description: | ##### Modalidade do Agente -
SIGLADescrição
AGTECAgente Estabelecimento Comercial
AGTOTAgente Outra Espécie de Pessoa Jurídica
AGPSSAgente Prestador de Serviço de Saque
+
SIGLADescrição
AGTECAgente Estabelecimento Comercial
enum: - "AGTEC" - - "AGTOT" - - "AGPSS" prestadorDoServicoDeSaque: type: "string" title: "Prestador do Serviço de Saque" @@ -3452,7 +3477,7 @@ components: 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. - Quando uma cobrança imediata tem uma estrutura de `retirada` ela deixa de ser considerada Pix comum e passa à categoria de Saque Pix. + Quando uma cobrança imediata tem uma estrutura de `retirada` ela deixa de ser considerada Pix comum e passa à categoria de Pix Saque ou Pix Troco. Para que o preenchimento do objeto `retirada` seja considerado válido as seguintes regras se aplicam: - os campos `modalidadeAgente` e `prestadorDoServicoDeSaque` são de **preenchimento obrigatório**; @@ -3522,7 +3547,7 @@ components: "retirada": { "troco": { "valor": "5.00", - "modalidadeAgente": "AGPSS", + "modalidadeAgente": "AGTEC", "prestadorDoServicoDeSaque": "12345678" } } @@ -3537,7 +3562,7 @@ components: "troco": { "valor": "0.00", "modalidadeAlteracao": 1, - "modalidadeAgente": "AGPSS", + "modalidadeAgente": "AGTEC", "prestadorDoServicoDeSaque": "12345678" } }, @@ -3571,7 +3596,7 @@ components: }, "troco": { "valor": "30.00", - "modalidadeAgente": "AGPSS", + "modalidadeAgente": "AGTEC", "prestadorDoServicoDeSaque": "12345678" } } @@ -3601,7 +3626,7 @@ components: "retirada": { "troco": { "valor": "5.00", - "modalidadeAgente": "AGPSS", + "modalidadeAgente": "AGTEC", "prestadorDoServicoDeSaque": "12345678" } } @@ -3805,6 +3830,7 @@ components: type: "string" title: "Pix Copia e Cola correspondente à cobrança." 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." + maxLength: 512 - $ref: "#/components/schemas/CobBase" CobSolicitada: type: "object" @@ -4502,7 +4528,7 @@ components: }, "troco": { "valor": "20.00", - "modalidadeAgente": "AGPSS", + "modalidadeAgente": "AGTEC", "prestadorDeServicoDeSaque": "12345678" } } @@ -4514,7 +4540,7 @@ components: "componentesValor": { "troco": { "valor": "20.00", - "modalidadeAgente": "AGPSS", + "modalidadeAgente": "AGTEC", "prestadorDeServicoDeSaque": "12345678" }, "original": { @@ -4587,7 +4613,7 @@ components: }, "troco": { "valor": "20.00", - "modalidadeAgente": "AGPSS", + "modalidadeAgente": "AGTEC", "prestadorDeServicoDeSaque": "12345678" } } @@ -4804,7 +4830,7 @@ components: pattern: "\\d{1,10}\\.\\d{2}" description: "Valor solicitado para devolução. A soma dos valores de todas as devolucões não podem ultrapassar o valor total do Pix." natureza: - $ref: "#/components/schemas/DevolucaoNatureza" + $ref: "#/components/schemas/DevolucaoSolicitadaNatureza" descricao: type: "string" title: "Mensagem ao pagador relativa à devolução." diff --git a/readme.md b/readme.md index 37e7609..c9f81f0 100644 --- a/readme.md +++ b/readme.md @@ -10,6 +10,6 @@ O branch `master` da API pode ser visualizado __[aqui](https://bacen.github.io/pix-api/index.html)__. -# Release atual: 2.6.0 +# Release atual: 2.6.1 -* A release atual da API Pix pode ser encontrada neste __[link](https://github.com/bacen/pix-api/releases/tag/2.6.0)__. +* A release atual da API Pix pode ser encontrada neste __[link](https://github.com/bacen/pix-api/releases/tag/2.6.1)__.