...
API - Pagamentos
/payments/
...
Iniciadora - Opcional
Detentora - Obrigatório
Casos de Uso
Os casos de uso fornecem uma visão clara e estruturada de quando o Webhook será acionado e o fluxo geral de das máquinas de estado.
...
Os eventos que acionarão notificações via Webhook na máquina de estados do consentimento do pagamento serão os status REJECTED e CONSUMED.
...
...
O status AUTHORISED deverá disparar notificações de acordo com a condição abaixo:
Caso o consentimento tenha atingido o status AUTHORISED após ter transitado pelo status PARTIALLY_ACCEPTED, o detentor deve notificar o Iniciador via Webhook;
Caso o consentimento tenha transitado diretamente para AUTHORISED, é facultada ao detentor a notificação.
Notificação sobre pagamento: Arranjo Pix
...
Os eventos que acionarão as notificações via Webhook na máquina de estados do pagamento: Arranjo Pix da API de Iniciação de Pagamentos serão: ACSC, RJCT, CANC, PATC, PDNG e SCHD.
...
...
Cenários de notificações
Cenários que podem ocorrer como resultado da convivência entre as chamadas assíncronas do Webhook e as chamadas síncronas do POST/payments ou POST/consents:
...
A detentora de contas envia uma notificação à instituição iniciadora de pagamento informando que ocorreu uma mudança significativa da máquina de estados da API e que a mesma deverá consultar o pagamento para obter mais informações.
Consulta de Consentimento
...
Consulta de Pagamento
...
Conteúdo do Payload/ URL
O payload será composto pela informação do timestamp do momento da alteração da situação do pagamento;
...
As URLs do ecossistema são formadas com a configuração abaixo:
<host> / <string> / <api> / <versão> / <recurso>
Detentoras de contas e/ou Transmissora de dados: Precisam construir a URI de notificação da seguinte forma:
...
...
Quando habilitar a funcionalidade de Webhook para a API de Pagamentos, a iniciadora de pagamentos deverá estar apta a receber notificações nos seguintes endereços:
https://itp.com/kong3/open-banking/webhook/[Versão do Webhook]/payments/[Versão da API]/consents/{consentId}https://itp.com/kong3/open-banking/webhook/[Versão do Webhook]/payments/[Versão da API]/pix/payments/{paymentId}
...
Parâmetro: x-webhook-interaction-i
Detentora: No header do request, deverá conter o parâmetro, contendo a seguinte descrição:
“Identificador único para cada tentativa de notificação realizada. O identificador deverá seguir o padrão UID RFC4122”
*O Campo é obrigatório
Iniciadora: No header do response, deverá conter o parâmetro, contendo a seguinte descrição:
...
*O Campo é obrigatório para a instituição que optar pela utilização da funcionalidade
O Parâmetro foi incluso nas tabelas abaixo:
Código de Resposta HTTP
Foi definido código de resposta HTTP específico para o Webhook, que pode ser consultado no link abaixo:
Segurança
Todos os endpoints do Webhook utilizam-se de mTLS para autenticação, não possuem scopes e permissions específicos de segurança. Toda a segurança é feita via certificado(mTLS – BRCAC).
* Não será necessário a assinatura do webhook, pois não vai haver dados sensíveis no conteúdo do Payload.
Orientação em caso de falha
...
A iniciadora de pagamentos, ao perceber que não está recebendo as notificações oriundas da detentora de contas, poderá utilizar os endpoints de consulta para obter informações sobre o andamento de uma determinada transação do consentimento e/ou pagamento.
Endpoints de Consulta:
Consulta de Consentimento | Consulta de Pagamento |
|---|---|
GET /consents/{consentId} | GET /pix/payments/{paymentId} |
Requisitos Não Funcionais
...