Notificações PIX
As notificações (postbacks) são um mecanismo de comunicação com o cliente para eventos relacionados as operações no DICT (reivindicação de posse e reivindicação de portabilidade) e nas transferências. A seguir, estão os detalhes dos postbacks que serão realizados em cada contexto do PIX.
DICT
Para os eventos de reivindicação de posse e reivindicação de portabilidade é necessário informar para a 4all uma URL com o tamanho máximo de 250 caracteres. Essa é uma URL do seu sistema que irá receber as notificações a cada alteração de status de uma reivindicação.
Para as reivindicações o evento será realizado para a URL em questão através de uma requisição POST contendo o seguinte corpo JSON (ContentType: application/json):
| Campo | Descrição | Formato |
|---|---|---|
| id | Identificador da reivindicação | String |
| type | Tipo da notificação: - DICT_ENTRY_CLAIM - DICT_ENTRY_CLAIM_NOTICE |
String |
| status | Status da reivindicação para o type DICT_ENTRY_CLAIM:- FAILED - Erro ao tentar abrir uma reivindicação; - CONFIRMED - Reivindicação confirmada pelo doador; - WAITING_RESOLUTION - Em análise (Reivindicação de posse); - CANCELLED - O doador ou reivindicador cancelou a reivindicação; - COMPLETED - Tanto o DICT quanto o reivindicador atualizaram suas bases com o novo vínculo; - OPEN - Reivindicação aberta com sucesso. Status da reivindicação para o type DICT_ENTRY_CLAIM_NOTICE:- LAST_DAY_RESOLUTION_DATE - Último dia antes do prazo final de resolução, passada a data limite as seguintes ações serão tomadas: em caso de reivindicação de posse ela será confirmada e em caso de reivindicação de portabilidade ela será cancelada; - DEFAULT_CONFIRMED_COMPLETED - O prazo final da resolução de reivindicação passou, portando ela foi confirmada; - LAST_DAY_COMPLETION_PERIOD_END - Último dia para validação de posse pois a data de encerramento está próxima de expirar; - EXPIRED_COMPLETION_PERIOD_END - O processo de reivindicação foi finalizado por conta do encerramento da data limite da validação de posse. |
String |
Transacional
Para os eventos de transferências pix (pix cash out), na rota Realizar transferência tem um campo específico chamado postback para informar a URL e o número de tentativas para realizar a notificação.
Para os eventos de recebimentos pix (pix cash in) é necessário informar para a Phi uma URL com o tamanho máximo de 250 caracteres.
A URL do pix cash out e pix cash in podem ser a mesma ou diferentes, dependerá da forma como elas serão implementadas no seu sistema. Porém, para ambos os casos, os eventos da parte transacional serão realizados para a URL em questão através de uma requisição POST contendo o seguinte corpo JSON (ContentType: application/json):
| Campo | Descrição | Formato |
|---|---|---|
| ref | Identificador do pix | String |
| type | Tipo da notificação: - PIX_CASH_IN - Recebimentos PIX efetivados - PIX_CASH_OUT_COMPLETED - Transferências PIX efetivadas - PIX_CASH_OUT_FAILED - Transferências PIX com falha |
String |
Para que seja considerado que a comunicação ocorreu com sucesso, a resposta da requisição deverá conter o código de status 200 ou 204 do protocolo HTTP. Caso ocorra um timeout na resposta ou a resposta contenha um status diferente dos citados anteriormente, serão efetuadas retentativas intervaladas entre si em pelo menos um minuto até um máximo de cinco vezes ou conforme definição do cliente. Caso ainda não se obtenha sucesso, NÃO serão feitas tentativas adicionais de comunicação da mudança de status.
O recurso de notificação está sujeito a falhas de comunicação, indisponibilidade de alguma das partes. Desta forma, não elimina a necessidade de consultas periódicas aos serviços que se deseja monitorar.
Outra questão importante é que a notificação pode ser forjada, então quando uma notificação for recebida não se deve assumir que a informação é confiável. O sistema da 4all deve ser consultado para confirmar se aquela informação realmente é válida ou não. De certa forma, a notificação deve ser usada como um trigger para ações.