Refund

Attributes

ParameterTypeDescription
id
string
The unique identifier for the refund.
status
enum
The status of the refund, one of created, succeeded or failed.
createdDate
string
The specific date and time that the refund process was initiated.
amount
integer
The final amount requested to refund the customer, in cents.
refundableAmount
integer
The full remaining refundable balance that can still be refunded, in cents. This field is only populated for partial refunds.
currency
string
The 3-letter currency code in ISO 4217 format. Currently we only support ZAR.
paymentId
string
The unique identifier of the payment associated with the refund.
failureReason
string
The reason for the refund failure, provided only when the refund fails.
mode
enum
The mode of the refund, one of either live or test.