Skip to main content
Realiza uma devolução de transferência via Pix.
Through this endpoint, the partner can return a received PIX to the source account whenever necessary. The API returns the status of a given transfer. Requirement A transaction code located in the PIX receipt callback must be entered to return the received funds.

Authorizations

Authorization
string
header
required

Copie 'Bearer ' + token

Headers

IdempotencyKey
string
required
IgnoraHandshake
boolean
default:true
required

(somente em homologação)

Body

codigoMovimento
string<uuid>

Identificador UUID da movimentação financeira que está relacionada à solicitação de devolução.*

valor
number<double>

Valor da devolução.*

motivoDevolucaoPix
enum<integer>

Motivo da devolucao do PIX.

Valores: 0 - AM05 1 - AM09 2 - FR01 3 - SL02 4 - FOCR 5 - BE08 6 - MD06 11 - UPAY

Available options:
0,
1,
2,
3,
4,
5,
6,
11
prioridadePix
enum<integer>

Prioridade do PIX.

Valores: 0 - URGENTE 1 - NORMAL

Available options:
0,
1
informacoesAdicionais
string | null

Detalhes adicionais relacionados à Devolução.*

Response

Success

sucesso
boolean
mensagem
string | null
codigoTransacao
string<uuid> | null