...
Participantes que desejam estender os padrões devem adicionar seu prefixo para identificar todas as extensões. Campos adicionais no retorno de endpoints existentes ou em novos endpoints devem usar o prefixo do participante. O prefixo deve ser criado no formato exposto ao lado (4 letras) e não devem haver seguinte formato: “EXT-”, seguidos por 4 letras, não devendo existir prefixos duplicados entre os participantes. Veja o exemplo Abaixo:
Exemplo de instituição fictícia: “EXT-FICT”
Nesta documentação, quando tivermos que nos referir ao prefixo do participante, o termo <PID>
será utilizado.
Exemplos de Código
Cada participantes terá um ID que representa a sua instituição. Os participantes da na atual versão estão listados deverão atualizar seus PIDs para contemplar o novo formato de PID conforme exemplo apresentado abaixo:
EXT-BBAS - Banco do Brasil
EXT-BBCD - Bradesco
EXT-BTGP - BTG Pactual
EXT-CAIX - Caixa Econônica Federal
EXT-ITAU - Itau
EXT-STDR - Santander
EXT-BRGS - Banrisul
EXT-BNBR - Banco do Nordeste do Brasil
EXT-BNDS - BNDES
EXT-CITI - Citibank
EXT-SAFR - Safra
EXT-BABV - Votorantim
Novas APIs
...
Extensão do versionamento
Como descrito na seção versionamento, o versionamento existe apenas no nível das APIs e não no nível dos endpoints, no entanto caso seja necessário realizar versionamento de um endpoint customizado, o participante poderá utilizar o header x-<PID>-v
para que o consumidor possa especificar qual versão do endpoint está requisitando.