v1

latestOpenAPI 3.0.12026-07-245303882.5 MB

Consultar o Status de uma Devolução de Recebimento Pix

get/pix/reverse/status

Query parameters

idstring

Identificador da transação retornado na requisição de payment.

clientCodestring

Identificador único gerado pelo cliente.

returnIdentificationstring

Identificador ponta-a-ponta associado a devolução pix.

Response

200

statusstring

versionstring

Example response

{
  "status": "CONFIRMED",
  "version": "1.0.0",
  "body": {
    "id": "34fee7bc-4d40-4605-9af8-398ed7d0d6b5",
    "amount": 25.55,
    "clientCode": "1458854",
    "originalPaymentId": "34fee7bc-4d40-4605-9af8-398ed7d0d6b5",
    "originalEndToEndId": "E3030629420200808185300887639654",
    "returnIdentification": "D3030629420200808185300887639654",
    "reason": "BE08",
    "reversalDescription": "D3030629420200808185300887639654",
    "error": {
      "errorCode": "CIE999",
      "message": "Ocorreu um erro interno durante a chamada da api."
    }
  }
}