QRCodes API

A API Pix padroniza os serviços oferecidos pelo PSP recebedor no contexto do arranjo Pix, incluindo:

Criação de cobranças

Verificação de Pix recebidos

Devoluções

Consultas

Os serviços disponibilizados permitem que o usuário recebedor integre sua automação diretamente com os serviços Pix do PSP.

Evolução da API Pix

A API Pix segue o padrão SemVer (Versionamento Semântico).
Alterações compatíveis não devem gerar uma nova versão major.

Estrutura da versão

A versão da API é composta por quatro elementos:

Major

Minor

Patch

Release Candidate

A versão exibida no path da URL (v[x]) representa o elemento major.

Regras de versionamento

🔴 Major

Alterações incompatíveis, com quebra de contrato
Exemplo: v1.0.0 → v2.0.0

🟡 Minor

Alterações compatíveis, sem quebra de contrato
Exemplo: v1.1.0 → v1.2.0

🟢 Patch

Correções de bugs e melhorias de documentação, sem alterações funcionais
Exemplo: v1.1.1 → v1.1.2

⚙️ Release Candidate (RC)

Versões de pré-lançamento para futuras versões (major, minor ou patch)
Exemplo: v1.0.0-rc.1 → v1.0.0-rc.22

Considerações importantes

Alterações compatíveis e melhorias na documentação podem ocorrer a qualquer momento.

⚠️ Clientes devem estar preparados para lidar com essas mudanças sem impacto na integração.

Mudanças retrocompatíveis esperadas

As seguintes alterações são consideradas seguras e não quebram contrato:

Adição de novos recursos na API Pix

Adição de novos parâmetros opcionais em cobranças

Adição de novos campos nas respostas da API

Alteração na ordem dos campos

Inclusão de novos valores em enumerações

Evolução da API

QRCodes API#

Evolução da API Pix#

Estrutura da versão#

Regras de versionamento#

🔴 Major#

🟡 Minor#

🟢 Patch#

⚙️ Release Candidate (RC)#

Considerações importantes#

Mudanças retrocompatíveis esperadas#