Skip to main content

Refund Request

Refund request including refund value and optional merchant unique ID.

refundAmountnumber<double>

Refund Amount (Conditional). Amount is required when Refund Value is 'Partial' (2).

refundRequestReasonstringrequired

Reason for the refund request.

Max length: <= 50 characters

refundRequestUniqueIdstring

Refund Request Unique Id.

Max length: <= 50 characters

refundValueinteger<int32>required

Refund value - Defaults to 'BaseAmount' (1) if not passed.

Enum ValueDescription
1Base
2Partial
3Full
Refund Request
{
  "refundAmount": 0,
  "refundRequestReason": "string",
  "refundRequestUniqueId": "string",
  "refundValue": 1
}