Saltar al contenido principal
POST
Return a parked received Pix to its payer

Autorizaciones

Authorization
string
header
requerido

JWT bearer token issued by the identity provider.

Parámetros de ruta

transactionId
string
requerido

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

Ejemplo:

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

Respuesta

Accepted

accountId
string
requerido

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

Ejemplo:

"@recebedor"

amount
integer<int64>
requerido

Refund amount in centavos.

Ejemplo:

5000

code
string
requerido

The PIX return reason.

Ejemplo:

"MD06"

endToEndId
string
requerido

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

Ejemplo:

"E1234567890"

endToEndRefundId
string
requerido

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

Ejemplo:

"D1234567890"

id
string
requerido

The created refund id.

Ejemplo:

"a2f9c0d1-..."

status
string
requerido

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

Ejemplo:

"EXECUTED"

description
string

Refund description.

Ejemplo:

"Wrong amount"