PIX Transactions
Devolver Pix recebido
Solicita devolução total ou parcial de um Pix já liquidado.
POST/integration/v1/pix/refund/{id}
Parâmetros de caminho
| Campo | Tipo | Descrição |
|---|---|---|
| id* | string | Identificador interno da transação a devolver. |
Corpo da requisição
| Campo | Tipo | Descrição |
|---|---|---|
| returnReasonCode* | string | Código de motivo da devolução conforme regra do arranjo Pix. |
| verify | object | Exemplo: {"type":"ALLOW"} |
| transaction* | object |
Exemplo de requisição
curl -X POST https://apiapp.dev.ideabank.com.br/integration/v1/pix/refund/{id} \
-H "Authorization: Bearer $TOKEN" \
-H "tenantid: $TENANT_ID" -H "hostdevelop: apiapp.dev.ideabank.com.br" -H "Content-Type: application/json" \
-d '{
"returnReasonCode": "MD06",
"verify": {
"type": "ALLOW"
},
"transaction": {
"accountId": "string",
"remoteId": "string",
"amount": 50,
"pixInfo": {
"description": "Devolução parcial solicitada pelo cliente"
}
}
}'Exemplo de resposta (200)
"object"Códigos de resposta
| HTTP | Descrição |
|---|---|
| 200 | Devolução registrada com sucesso |
| 401 | |
| 403 | |
| 404 | |
| 409 | |
| 422 | |
| 500 |
Fonte
Esta página é gerada a partir do Swagger oficial. Para o payload autoritativo, consulte também a especificação viva.