curl --request POST \
  --url https://api.ext.pix.dbs.moneyp.dev.br/api/Recurso/Devolver \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'IdempotencyKey: <idempotencykey>' \
  --header 'IgnoraHandshake: <ignorahandshake>' \
  --data '{
  "codigoMovimento": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "valor": 123,
  "motivoDevolucaoPix": 0,
  "prioridadePix": 0,
  "informacoesAdicionais": "<string>"
}'
{
  "sucesso": true,
  "mensagem": "<string>",
  "codigoTransacao": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Through this endpoint, partners can return a received Pix payment to the originating account whenever necessary.

The API returns the status of the specific transfer.

Requirement

A movement code found in the Pix receipt callback is required to process the return of the received funds.

Authorizations

​
Authorization
string
header
required

Copie 'Bearer ' + token

Headers

​
IdempotencyKey
string
required

Chave única para garantir que uma operação seja executada apenas uma vez.

​
IgnoraHandshake
boolean
default:true
required

(somente em homologação)

Body

​
codigoMovimento
string

Identificador UUID da Movimentação Financeira que está relacionada à solicitação de Devolução.

​
valor
number

Valor da devolução.

​
motivoDevolucaoPix
enum<integer>

0 = Ordem de pagamento em duplicidade (Obsoleto); 1 = Devolução devido ao valor recebido não estar de acordo com o esperado (Obsoleto); 2 = Devolução fundada por suspeita de fraude; 3 = Devolução de pagamento solicitada pelo usuário recebedor motivada por um erro na transação; 4 = Devolução após solicitação de cancelamento da transação (Obsoleto); 5 = Falha operacional do PSP do pagador; 6 = Devolução solicitado pelo usuário recebedor do pagamento original; 11 = Ordem de pagamento não justificada (Obsoleto)

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

0 = URGENTE; 1 = NORMAL

Available options:
0,
1
​
informacoesAdicionais
string | null

Detalhes adicionais relacionados à Devolução.

Response

200 - application/json
Success
​
sucesso
boolean

Indica se a operação foi realizada com sucesso.

​
mensagem
string | null

Descrição detalhada do resultado da operação, incluindo informações sobre erros ou mensagens complementares.

​
codigoTransacao
string | null

Código UUID da transação.

Was this page helpful?