Solicitar estorno parcial ou integral de um Pix
POST
/api/Pix/DevolucaoPix
Pix
Funcionalidade principal
Para executar o estorno, é fundamental identificar a transação original através do seu identificador único, o EndToEnd. Além dele, você deve especificar oValora ser devolvido, que pode ser igual ou menor que o valor original da transação.
Casos de uso comuns
1.
2.
3.
4.
Nota importante: O processo de devolução do PIX é assíncrono. Esta chamada de API apenas inicia a solicitação de estorno. Para confirmar que a devolução foi concluída com sucesso, é necessário consultar o status da operação utilizando o endpoint "Consulta Devolução Pix".
Requisição
Parâmetros Header
Parâmetros Bodyapplication/jsonNecessário
Respostas
Request Request Example
Shell
JavaScript
Java
Swift
curl --location '/api/Pix/DevolucaoPix' \
--header 'UserName;' \
--header 'RequestOrigin;' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"Data": {
"CodigoCanal": 0,
"CodigoCliente": 0,
"End2End": "string",
"Valor": 0,
"Descricao": "string"
}
}'Response Response Example
{
"Data": {
"IdComprovante": 0,
"IdLancamento": 0,
"IdTipoOperacao": "string",
"DescTipoOperacao": "string",
"IdOperacao": "string",
"Descricao": "string",
"VersaoLayout": 0,
"DadosComprovante": "string",
"DataOperacao": "2019-08-24T14:15:22.123Z"
},
"ResultCode": 0,
"Message": "string",
"ValidationData": {
"ResultCode": 0,
"Message": "string",
"Errors": [
{
"ErrorMessage": "string",
"FieldName": "string"
}
]
}
}Modificado em 2026-03-03 15:10:05