Devolução Pix

Pré requisitos para implementação:

  • Possuir uma chave api da Celcoin, para mais informações acessar esse link

  • Ter familiaridade com apis Rest usando o protocolo OAuth 2.0.

  • Ter o produto/solução contratada, caso queira usar a funcionalidade em ambiente produtivo, por favor entre em contato com a nossa equipe comercial através do e-mail [email protected] Para dúvidas técnicas, basta entrar em contato com o suporte através do link.

  • Ter uma chave pix cadastrada, caso sua empresa não tenha, basta entrar em contato com o nosso suporte, informando uma chave que nós realizamos esse cadastro. Não recomendamos o envio de um CNPJ, ou e-mail para esse cadastro devido a possibilidade de fraudes.

Essa funcionalidade deve ser utilizada sempre que sua aplicação desejar realizar a devolução de um valor pix.

Caso de uso:

Como Fintech quero disponibilizar para os meus usuários, a possibilidade de devolver um valor de uma transação pix, onde ele deve preencher apenas o valor que deseja reembolsar dentro de uma transferência recebida e clicar em devolver, onde o valor será estornado parcialmente, ou completamente para a entidade que fez a transferência, ou pagamento.

Devolução do Pix

Para realizar uma devolução é necessário que a sua conta Celcoin tenha recebido uma transação, sendo assim, será disparado um gatilho (RECEIVEPIX) em seu webhook.

O webhook é uma forma de receber informações de forma assíncrona, onde geralmente são disparados gatilhos no formato JSON quando um evento acontece. Para realizar a configuração de um webhook é necessário entrar em contato com a nossa equipe de suporte informando a url de seu webhook, senha e usuário(caso exista), no formato BASIC, desta forma eles irão realizar o cadastro dele em nossa plataforma para que seja possível o envio dos gatilhos.

Após receber o gatilho, deve ser realizado uma chamada na api Cria uma devolução (estorno) de um PIX já pago, onde precisa ser informado o transactionId (Identificador da transação original recebido no gatilho de “RECEIVEPIX), transactionIdentification (Identificador único para a transação. Deve ser um inteiro) e a propriedade reason campo para definir qual motivo da devolução, podendo ser:

BE08: Devolvido como resultado de um erro bancário.
FR01: Devolução por suspeita de fraude.
MD06: Devolução solicitada pelo cliente final.
SL02: Devolução do valor em dinheiro devido a um erro relacionado ao Pix Saque ou Pix Troco

Modelo de request:

curl -X 'POST' \
  'https://sandbox.openfinance.celcoin.dev/pix/v1/reverse/6098113' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json-patch+json' \
  -H 'Authorization: Bearer [ACESS_TOKEN]'\
  -d '{
  "transactionIdentification": 1235485,
  "amount": 150.54,
  "reason": "BE08",
  "additionalInformation": "Devolvido como resultado de um erro bancário"
}'

Modelo de request:

{
  "paymentDevolutionId": 856478,
  "transactionId": 45854857,
  "clientRequestId": 0,
  "amount": 10.55,
  "reason": "NARR",
  "originalPactualId": "UPAY",
  "returnIdentification": "D3030629420200808185300887639654",
  "entity": "PixReversal",
  "pactualId": "45fe6866-21a5-4f6d-84c2-950a2a1df8e7",
  "status": "PROCESSING"
}

🚧

Recomendamos que seja armazenado a propriedade transactionId retornada no request da solicitação de devolução, pois será enviado o gatilho REVERTPIX, para informar sua aplicação que o estorno ocorreu com sucesso e para validar isso o ideal é usar esse campo.


Did this page help you?