Skip to main content
POST
cURL com dados fictícios

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider.

Cabeçalhos

Idempotency-Key
string
obrigatório

Chave criada pelo cliente para repetir com segurança exatamente a mesma requisição.

Required string length: 1 - 64
X-Correlation-Id
string

Best-effort business correlation id (observability only; never fabricated).

Parâmetros de caminho

id
string
obrigatório

Refund internal ID (UUID format)

Exemplo:

"018f8c1d-1234-7abc-9def-000000000010"

Resposta

Accepted

alreadySettled
string
obrigatório
Exemplo:

"50.00"

blocksStatus
enum<string>
obrigatório
Opções disponíveis:
SETTLING,
PENDING,
SETTLED
Exemplo:

"SETTLING"

operationType
enum<string>
obrigatório
Opções disponíveis:
ROOT,
SUBSEQUENT,
UNKNOWN
Exemplo:

"ROOT"

originalAmount
string
obrigatório
Exemplo:

"200.00"

refundId
string
obrigatório
Exemplo:

"018f8c1d-1234-7abc-9def-000000000010"

status
enum<string>
obrigatório
Opções disponíveis:
OPEN,
CLOSED,
CANCELLED
Exemplo:

"OPEN"

blocks
object[] | null
endToEndId
string
settleAmount
string
Exemplo:

"150.00"

settleReason
string
Exemplo:

"FR01"

settleType
enum<string>
Opções disponíveis:
REFUND,
MANUAL
Exemplo:

"REFUND"

settled
boolean
Exemplo:

false

surplusAmount
string
Exemplo:

"50.00"