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
Example:

"D12345678202601011200abcdef01234"

failureReason
string
result
enum<string>
Available options:
SUCCESS,
FAILED
Example:

"SUCCESS"

Response

OK

alreadySettled
string
required
Example:

"50.00"

blocksStatus
enum<string>
required
Available options:
SETTLING,
PENDING,
SETTLED
Example:

"SETTLING"

operationType
enum<string>
required
Available options:
ROOT,
SUBSEQUENT,
UNKNOWN
Example:

"ROOT"

originalAmount
string
required
Example:

"200.00"

refundId
string
required
Example:

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

status
enum<string>
required
Available options:
OPEN,
CLOSED,
CANCELLED
Example:

"OPEN"

blocks
object[] | null
endToEndId
string
failureReason
object
settleAmount
string
Example:

"150.00"

settleReason
string
Example:

"FR01"

settleType
enum<string>
Available options:
REFUND,
MANUAL
Example:

"REFUND"

settled
boolean
Example:

false

surplusAmount
string
Example:

"50.00"