Pular para o conteúdo principal
POST
Return a parked received Pix to its payer

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider.

Parâmetros de caminho

transactionId
string
obrigatório

The received Pix's transaction id (local UUID), as GET /v1/transactions lists it.

Exemplo:

"019fb9b6-7593-7667-abe9-3b087192747b"

Resposta

Accepted

accountId
string
obrigatório

The Midaz alias of the account the refund debits: the one the original credited, or the indirect's @pi_{ispb} on an indirect refund.

Exemplo:

"@recebedor"

amount
integer<int64>
obrigatório

Refund amount in centavos.

Exemplo:

5000

code
string
obrigatório

The PIX return reason.

Exemplo:

"MD06"

endToEndId
string
obrigatório

The original transaction's end-to-end id.

Exemplo:

"E1234567890"

endToEndRefundId
string
obrigatório

The refund's own end-to-end id, filled when JD supplies it; may be empty while PENDING, which is not a failure.

Exemplo:

"D1234567890"

id
string
obrigatório

The created refund id.

Exemplo:

"a2f9c0d1-..."

status
string
obrigatório

eTransactionStatus name. A refund sent over SPI answers PENDING until SPI settles it.

Exemplo:

"EXECUTED"

description
string

Refund description.

Exemplo:

"Wrong amount"