Skip to main content
POST
Return a parked received Pix to its payer

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Path Parameters

transactionId
string
required

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

Example:

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

Response

Accepted

accountId
string
required

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

Example:

"@recebedor"

amount
integer<int64>
required

Refund amount in centavos.

Example:

5000

code
string
required

The PIX return reason.

Example:

"MD06"

endToEndId
string
required

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

Example:

"E1234567890"

endToEndRefundId
string
required

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

Example:

"D1234567890"

id
string
required

The created refund id.

Example:

"a2f9c0d1-..."

status
string
required

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

Example:

"EXECUTED"

description
string

Refund description.

Example:

"Wrong amount"