Skip to main content
POST
cURL with fictitious data

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Headers

Idempotency-Key
string
required

Client-generated key used to retry exactly the same request safely.

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

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

Path Parameters

id
string
required

Refund internal ID (UUID format)

Example:

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

Body

application/json
endToEndId
string
required
Example:

"D12345678202601011210abcdef01234"

explanation
string
required
Example:

"devolucao conciliada manualmente apos falha do settle"

Response

OK

alreadySettled
string
required
Example:

"200.00"

blocks
object[] | null
required
blocksStatus
enum<string>
required
Available options:
SETTLED
Example:

"SETTLED"

endToEndId
string
required
Example:

"D12345678202601011210abcdef01234"

originalAmount
string
required
Example:

"1000.00"

refundId
string
required
Example:

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

settledAmount
string
required
Example:

"800.00"

surplusAmount
string
required
Example:

"200.00"