v1

latestOpenAPI 3.0.12026-07-245303882.5 MB

Criar devolução (estorno) de um Pix recebido

Essa API possibilita que seja realizada a devolução de um Pix recebido.Criamos um artigo explicando como implementar essa api.

post/pix/v2/reverse/pi/{transactionId}

Path parameters

transactionIdstring required

ID do recebimento a ser estornado

Request body

clientCodestring

Identificador único para a transação.

amountnumber double required

Valor a ser devolvido. O valor não pode ser maior que o valor da transação de recebimento original.

reason'BE08' | 'FR01' | 'MD06' | 'SL02' required

Código da razão da devolução. |BE08: Devolvido como resultado de um erro bancário.| FR01: Devolução por suspeita de fraude. |MD06: Devolução solicitada pelo cliente final. | SL02: Devolução do valor em dinheiro devido a um erro relacionado ao Pix Saque ou Pix Troco.

additionalInformationstring

Descritivo opcional para a devolução caso o motivo de retorno esteja fora dos valores possíveis na Tabela de reason - (até 105 caracteres )

reversalDescriptionstring

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

Response

200

statusinteger

transactionIdinteger

amountinteger

messagestring

Example response

{
  "status": 200,
  "transactionId": 817847550,
  "amount": 10,
  "message": "PROCESSING"
}