Consultar o Status de uma Devolução de Recebimento Pix
Com essa chamada você realizará a consulta de uma devolução de recebimento Pix.
Passos para Integrar
- Realizar autenticação na API - [API Reference]
- Consultar uma devolução Pix -[API Reference]
Consulta devoluções de pagamentos
Essa funcionalidade pode ser utilizada após receber o gatilho de webhook "pix-reversal-out". Com os identificadores, é possivel obter os dados da devolução de um pagamento realizado.
cURL da chamada
curl --location --request GET 'https://sandbox.openfinance.celcoin.dev/baas-wallet-transactions-webservice/v1/pix/reverse/status?returnIdentification=D3030629420200808185300887639654' \
--header 'accept: application/json' \
--header 'Authorization: Bearer {{token}}'
Parâmetros para realizar busca
| Status | Descrição |
|---|---|
| id | Identificador da transação retornado na requisição de payment. |
| clientCode | Identificador único gerado pelo cliente. |
| returnIdentification | Identificador ponta-a-ponta associado a devolução pix. |
Exemplo de retorno
Sucesso 200
{
"status": "PROCESSING",
"version": "1.0.0",
"body": {
"id": "34fee7bc-4d40-4605-9af8-398ed7d0d6b4",
"amount": 25.55,
"clientCode": "1458854",
"originalPaymentId": "34fee7bc-4d40-4605-9af8-398ed7d0d6b5",
"endToEndId": "E3030629420200808185300887639654",
"returnIdentification": "D3030629420200808185300887639654",
"reason": "MD06",
"reversalDescription": "Devolução do churrasco"
}
}
Error 400
{
"version": "1.0.0",
"status": "ERROR",
"error": {
"errorCode": "CBE001",
"message": "ClientCode é obrigatório."
}
}
Tabela de errorCode
| Code | Message |
|---|---|
| CBE161 | É necessário informar pelo menos um dos campos: id, clientCode, ou returnIdentification. |
Error 401 | Error 404 | Error 500 | Error 504
{
"version": "1.0.0",
"status": "ERROR",
"error": {
"errorCode": "CIE999",
"message": "Ocorreu um erro interno durante a chamada da api."
}
}
Updated 9 days ago