Skip to main content
POST
Create a PIX refund

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Body

application/json
accountId
string
required

The requesting account (the original payee).

Example:

"acc-123"

amount
integer<int64>
required

Refund amount in centavos (must be greater than zero).

Example:

5000

code
string
required

PIX return reason (BE08/FR01/MD06/SL02).

Example:

"MD06"

endToEndId
string
required

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

Example:

"E1234567890"

transactionId
string
required

The original transaction id (UUID).

Example:

"d1f9c0a2-..."

clientRequestId
string

Optional client idempotency token. A retry carrying the same value replays the existing refund instead of creating a duplicate (intra-PSP double-refund protection); omit to opt out.

Example:

"req-2025-01-01-abc123"

description
string

Free-text refund description.

Example:

"Wrong amount"

Response

Created

accountId
string
required

The refunding account id.

Example:

"ext-acc-123"

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.

Example:

"D1234567890"

id
string
required

The created refund id.

Example:

"a2f9c0d1-..."

status
string
required

eTransactionStatus name.

Example:

"EXECUTED"

description
string

Refund description.

Example:

"Wrong amount"