Skip to main content
POST
Create a PIX refund

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider.

Corpo

application/json
accountId
string
obrigatório

The requesting account (the original payee).

Exemplo:

"acc-123"

amount
integer<int64>
obrigatório

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

Exemplo:

5000

code
string
obrigatório

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

Exemplo:

"MD06"

endToEndId
string
obrigatório

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

Exemplo:

"E1234567890"

transactionId
string
obrigatório

The original transaction id (UUID).

Exemplo:

"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.

Exemplo:

"req-2025-01-01-abc123"

description
string

Free-text refund description.

Exemplo:

"Wrong amount"

Resposta

Created

accountId
string
obrigatório

The refunding account id.

Exemplo:

"ext-acc-123"

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.

Exemplo:

"D1234567890"

id
string
obrigatório

The created refund id.

Exemplo:

"a2f9c0d1-..."

status
string
obrigatório

eTransactionStatus name.

Exemplo:

"EXECUTED"

description
string

Refund description.

Exemplo:

"Wrong amount"