v1

latestOpenAPI 3.0.12026-07-245303882.5 MB

Consulta uma devolução de pagamento Pix recebida

Endpoint destinado à consulta de detalhes posterior ao recebimento do webhook de devolução de pagamento Pix (pix-reversal-in ou REVERTED)

get/pix/v2/receivement/v2/devolution/status

Query parameters

returnIdentificationstring

EndToEnd da devolução

transactionIdinteger

Identificador da devolução

clientCodestring

Identificador informado pelo cliente no momento da criação do cash-out.

Response

200

statusstring

returnIdentificationstring

additionalInformationstring

originalEndToEndIdstring

transactionIdinteger

transactionIdPaymentinteger

transactionTypestring

amountinteger

reasonstring

reversalDescriptionstring

createdAtstring

Example response

{
  "status": "string",
  "returnIdentification": "string",
  "additionalInformation": "string",
  "originalEndToEndId": "string",
  "transactionType": "string",
  "reason": "string",
  "reversalDescription": "string",
  "createdAt": "2024-04-04T17:55:50.378Z"
}