Fluxo de recebimento de Restituição
O fluxo de restituição segue a mesma mecânica do fluxo de recebimento de Pix, e tem início com a chegada (RES1) ao Banco BS2 de uma mensagem PACS.004 (devolução), encaminhada pelo SPI.
Sendo uma mensagem destinada ao participante indireto, o Banco BS2 solicitará, de modo síncrono, ao participante que valide o crédito (RES2) através da chamada de uma API desenvolvida pelo próprio participante indireto.
Caso o participante não responda a requisição dentro do limite de tempo definido, tentaremos reenviar a notificação. (Saiba mais em Webhooks para participantes indiretos).
Importante:
O tempo hábil para responder à requisição de validação da restituição é de até 300ms.
Persistindo o problema, o Banco BS2 retornará ao SPI o código de erro AB09 (Transação interrompida devido a erro no participante do usuário recebedor) e a restituição não será efetivada.
Caso a transação seja validada e possa prosseguir, o participante deverá retornar o return code 200 e, em caso de rejeição, retornar também o 200, mas especificando o motivo conforme a tabela de domínios SPI para rejeições de restituições.
Após o retorno da etapa (RES2), o Banco BS2 criará a mensagem PACS.002 (validação) com a resposta recebida do participante indireto e a encaminhará para o SPI (RES3).
O SPI registrará a operação na conta PI dos participantes diretos e, em seguida, notificará a esses mesmos participantes diretos que a transação foi finalizada (DEV7 e RES4).
No momento em que o Banco BS2 recebe a PACS.002 (confirmação), realizamos o crédito do valor na conta Lastro do participante indireto (RES5), e o notificamos através do WebHook cadastrado (RES6) (Saiba mais em Configuração de notificações).
A partir deste ponto, caberá ao participante indireto realizar o crédito (RES7), notificação para o cliente final (RES8) e, se for o caso, realizar integrações com seus processos (RES9).
Consulta de restituições
Por meio das funcionalidades abaixo, a busca por uma lista ou restituição específica são possibilitadas.
Lista de restituições
Nesta funcionalidade permitimos a obtenção de uma lista de restituições vinculadas a uma transação Pix.
Solicitamos os campos:
| Campo | Descrição | Formato | Obrigatório |
|---|---|---|---|
| endToEndId | Identificador do pagamento que originou a restituição | string | Sim |
Resposta:
| Campo | Descrição | Formato | Nullable |
|---|---|---|---|
| returnId | Identificador da restituição | string | Sim |
| endToEndId | Identificador do pagamento que originou a restituição | string | Sim |
| valor | Valor da restituição | double | Sim |
| status | Status da restituição, conforme tabela Status da restituição | string | Sim |
| solicitadoEmUtc | Data e hora em que a restituição foi solicitada | date-time | Sim |
| liquidadoEmUtc | Data e hora em que a restituição foi efetivada | date-time | Sim |
| dataContabil | Data da contábil da restituição | date-time | Sim |
| codigoDevolucao | Código do motivo da devolução que será enviado na PACS004, conforme tabela Motivos de devolução | string | Sim |
| tipoDevolucao | Tipo da devolução, conforme tabela Tipo de devolução | string | Sim |
| prioridadeTransacao | Prioridade de envio da transação, conforme tabela Tipo Prioridade | string | Sim |
| motivo | Mensagem destinada ao recebedor | string | Sim |
| motivoRejeicao | Código e descrição do motivo da rejeição da transação que foi informado pelo BACEN na PACS002 | object | Sim |
| erroDescricao | Descrição do erro na restituição | string | Sim |
| erroEmUtc | Data e hora da ocorrência do erro | date-time | Sim |
| webhooks | Informações a respeitos das notificações enviadas ao participante indireto da restituição | array | Sim |
Consulta de restituição
Nesta funcionalidade permitimos consultar uma restituição específica.
Solicitamos os campos:
| Campo | Descrição | Formato | Obrigatório |
|---|---|---|---|
| endToEndId | Identificador do pagamento que originou a restituição | string | Sim |
| returnId | Identificador da transação de restituição | string | Sim |
Resposta:
| Campo | Descrição | Formato | Nullable |
|---|---|---|---|
| returnId | Identificador da restituição | string | Sim |
| endToEndId | Identificador do pagamento que originou a restituição | string | Sim |
| valor | Valor da restituição | double | Sim |
| status | Status da restituição, conforme tabela Status da restituição | string | Sim |
| solicitadoEmUtc | Data e hora em que a restituição foi solicitada | date-time | Sim |
| liquidadoEmUtc | Data da liquidação da restituição | date-time | Sim |
| dataContabil | Data contábil da restituição | date-time | Sim |
| codigoDevolucao | Código do motivo da devolução que será enviado na PACS004, conforme tabela Motivos de devolução | string | Sim |
| tipoDevolucao | Tipo da devolução, conforme tabela Tipo de devolução | string | Sim |
| prioridadeTransacao | Prioridade de envio da transação, conforme tabela Prioridade da Transação | string | Sim |
| motivo | Mensagem destinada ao recebedor | string | Sim |
| motivoRejeicao | Código e descrição do motivo da rejeição da transação que foi informado pelo BACEN na PACS002 | object | Sim |
| erroDescricao | Descrição do erro na transação de restituição | string | Sim |
| erroEmUtc | Data e hora da ocorrência | date-time | Sim |
| webhooks | Informações a respeitos das notificações enviadas ao participante indireto da restituição | array | Sim |
Updated 5 months ago