v1

latestOpenAPI 3.0.12026-07-245303882.5 MB

Iniciar a Devolução de um Recebimento Pix

Retornará o evento de confirmação via webhook pix-reversal-out

post/pix/reverse

Request body

idstring

Identificador da transação do recebimento pix.

endToEndIdstring

Identificador ponta-a-ponta associado ao recebimento pix.

clientCodestring required

Identificador único gerado pelo cliente.

amountnumber double required

Valor da transação.

reasonstring required

Razão da Devolução.

reversalDescriptionstring

Texto opcional a ser apresentado ao pagador contendo informações sobre a devolução..

Response

200

statusstring

versionstring

Example response

{
  "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"
  }
}