Contexto


Neste artigo, vamos apresentar como realizar uma devolução de um recebimento Pix por meio da nossa API. A devolução é permitida conforme as normas do Bacen, desde que respeite os critérios definidos para segurança e rastreabilidade.


Pré-requisitos


Antes de realizar uma devolução Pix, certifique-se de que:

  • Está autenticado com um token válido da nossa API;
  • Possui client_id e client_secret ativos;
  • Salvou previamente o transactionId da transação recebida via Pix;
  • O valor a ser devolvido é igual ou inferior ao valor recebido;
  • A transação está dentro do prazo máximo de 90 dias após o recebimento.


1. Criar Devolução de Pix 


▶️ Endpoint


POST {{url}}/v1/accounts/{{accountId}}/instant-payments/{{transactionId}}/returns


Exemplo de payload: 


{

  "externalIdentifier": "{{UUID}}",

  "amount": {{totalAmount}},

  "returnReasonCode": "{{reasonCode}}",

  "mediatorFee": 0

}


2. Parâmetros da Requisição 


Parâmetro
Descrição
externalIdentifier
Identificador único para rastreamento da devolução (UUID).
amount
Valor a ser devolvido (igual ou menor que o valor recebido).
returnReasonCode
Código que indica o motivo da devolução.
mediatorFee
Valor da taxa de mediação (normalmente 0).



⚠️ Observações Importantes


returnReasonCode: As devoluções solicitadas pela API precisam ter o código: MD06 – Devolução de pagamento instantâneo solicitado pelo usuário recebedor.



Suporte


Para dúvidas ou acompanhamento de chamados, acesse: Portal de Suporte