v1

latestOpenAPI 3.0.12026-07-245303882.5 MB

Consulta o status de uma devolução de recebimento Pix criada

Endpoint destinado à consulta de status posterior ao recebimento de webhook ou em caso de muita demora para o recebimento da confirmação.

get/pix/v2/reverse/pi/status

Query parameters

returnIdentificationstring

EndToEnd da devolução

transactionIdinteger

Identificador da devolução

clientCodestring

Código interno informado pelo cliente no momento da criação da devolução.

Response

200

statusstring
returnIdentificationstring
additionalInformationstring
clientCodestring
originalEndToEndIdstring
transactionIdinteger
amountinteger
reasonstring

Example response

{
  "status": "ERROR",
  "returnIdentification": "E22896455202211101038nbxkcXYX",
  "additionalInformation": "ABCD",
  "clientCode": "123",
  "originalEndToEndId": "E22896431203344101038nbxkcXYZ",
  "transactionId": 123,
  "amount": 10,
  "reason": "BE08",
  "error": {
    "code": "PBE150",
    "description": "General reject operation."
  }
}