Releases: bacen/pix-api
Releases · bacen/pix-api
2.8.0
- Correção do campo
destinatario
de opcional para obrigatório no schema daSolicitação de Recorrência
doPOST /solicRec
. - Remoção do campo
recebedor
, desnecessário, do exemplo emPOST /rec
. - Incluída a obrigatoriedade dos campos
parametros
ecobrs
noGET /cobr
para seguir o comportamento similar ao existente para as demais consultas de outras entidades. - Incluída a obrigatoriedade dos campos
parametros
erecs
noGET /rec
para seguir o comportamento similar ao existente para as demais consultas de outras entidades. - Pequenos ajustes de texto na seção
Tratamento de Erros
. - Ajuste do exemplo na retentativa quando a política não permite, lançando erro 400.
- Ajuste nas descrições dos identificadores de recorrência e solicitação de recorrência.
2.7.0
- Inclusão do campo
rec.dadosQR
contendo os campospixCopiaECola
ejornada
referentes ao response do GET/rec/{idRec}?txid={txid}
fornecendo informações complementares relacionadas a respectiva jornada e QRCode com exemplos. - Remoção do campo
rec.pagador
no response do POST/rec
e PATCH/rec/{idRec}
. - Remoção do campo
rec.cobr
no response do GET/rec
e GET/rec/{idRec}
e inseridoidRec
como parâmetro de busca em GET/cobr
. - Ajuste no campo
cobr.dadosDevedor
substituído porcobr.devedor
. - Ajuste no campo
cobr.contaRecebedor
substituido porcobr.recebedor
. - Ajuste no campo
cobr.valor
substituido porcobr.valor.original
. - Ajuste no campo
cobr.ajusteDiaUtil
para valor defaulttrue
. - Inclusão do campo
cobr.vinculo.devedor.nome
no request do PATCH/cobr/{txid}
.
2.7.0-RC1
- Inclusão das tags relacionadas ao Pix Automático:
RecPayload
: que reúne os endpoints (locations) utilizados pelo software do PSP pagador para recuperar o payload JSON que representa uma recorrência;Rec
: que reúne os endpoints destinados a lidar com o gerenciamento de recorrências;SolicRec
: que reúne os endpoints destinados a lidar com o gerenciamento de solicitações de confirmação de recorrências;CobR
: que reúne os endpoints destinados a lidar com o gerenciamento de cobranças associadas a uma recorrência;PayloadLocationRec
: que reúne os endpoints destinados a lidar com a configuração e a remoção de locations para uso dos payloads de recorrências;WebhookRec
: que reúne os endpoints para o gerenciamento de notificações de recorrências por parte do PSP recebedor ao usuário recebedor; eWebhookCobR
: que reúne os endpoints para o gerenciamento de notificações de cobranças recorrentes por parte do PSP recebedor ao usuário recebedor.
2.6.3
- Inclusão de esclarecimento referente ao domínio
AGPSS
do campomodalidadeAgente
para Pix Saque e Pix Troco, dispondo que ele deve ser convertido paraAGFSS
na elaboração da mensagempacs.008
. Optou-se pela não alteração desse domínio (paraAGFSS
) na API Pix neste momento, ficando a uniformização com o Catálogo de Mensagens do SPI reservada para a próxima major version da API Pix. - Descontos em cobranças com vencimento agora podem ser aplicados para datas menores ou iguais à data de vencimento.
- Correção dos exemplos
F
eG
conforme apontado na issue [#485]. - Uniformização das descrições dos campos
/lotecobv/{id}
do request eid
no response do GET/lotecobv/{id}
que semânticamente são o mesmo valor. - Remoção do 'pagador' como campo obrigatório do 'Pix' no seu respectivo schema.
2.6.2
[2.6.2]
- Inclusão do valor
AGTOT
no domínio do campovalor.retirada.troco.modalidadeAgente
. - Ajuste da descrição do valor domínio
AGTOT
de 'Agente Outra Espécie de Pessoa Jurídica' para 'Agente Outra Espécie de Pessoa Jurídica ou Correspondente no País'. - Exclusão do valor
AGPSS
dos domínios dos camposPixValorTroco.troco.modalidadeAgente
eCobPayload.valor.retirada.troco.modalidadeAgente
. - Substituição da expressão 'Prestador de Serviços de Saque' por 'Facilitador de Serviço de Saque' em linha com a nova instrução normativa.
- Correção do exemplo 'cobrança com troco alterável' para inclusão da estrutura
retirada
. - Correção do exemplo 'troco com valor.original alterável', estrutura
retirada.troco
comAGTOT
.
2.6.1
2.6.0
[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 objetoPix
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
[2.5.0]
- Inclusão do atributo
retirada
como campo opcional do objetovalor
nos endpoints de consulta, criação e revisão da cobrança imediata. O campo pode ser preenchido com os atributossaque
outroco
exclusivamente, detalhados pelos atributosvalor
emodalidadeAlteracao
. Se apresentarem o campomodalidadeAlteracao
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 portipo
evalor
. - 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-rc.0
- Inclusão do atributo
retirada
como campo opcional do objetovalor
nos endpoints de consulta, criação e revisão da cobrança imediata. O campo pode ser preenchido com os atributossaque
outroco
exclusivamente, detalhados pelos atributosvalor
emodalidadeAlteracao
. Se apresentarem o campomodalidadeAlteracao
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 portipo
evalor
. - Formatações gerais de referências a campos, objetos e schemas.
2.3.0
modalidadeAlteracao
agora é um campo opcional do objetovalor
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]: corrige "case" do padrão de datas de
yyyy-mm-dd
->YYYY-MM-DD
. - [#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]: Adiciona dois cenários de erro para o endpoint
PUT /pix/{e2eid}/devolucao/{id}
na seção de tratamentos de erros. - [#357]: aprimora a descrição do campo "motivo" no retorno do endpoint
/pix/{e2eid}/devolucao/{id}
.