Skip to main content

Refund

Object

NameTypeMandatoryDescription
classstringYThe type of object which is being returned. In this case it will be refund.
idintYThe SysPay reference of the returned refund.
referencestringYThe Merchant refund identifier which was sent on in the request call.
amountintYThe amount in cents.
currencystringYThe currency (ISO-4217).
statusstringYThe refund status. See statuses.
processing_timeunix timestampYThe time stamp of when the refund was processed. Null is returned if the transaction is still not complete.
descriptionstringNThe refund description which was sent on in the request call.
extrastringNThe extra parameter which was sent on in the request call.
failure_categorystringNWhen the operation fails, this parameter will include extra information about the error. See Failure categories.
paymentobjectYThe original payment object. See Payment object.

Refund statuses

StatusFinalDescription
SUCCESSYThe refund has been completed successfully.
FAILEDYThe refund has been refused.
WAITINGNThis means we are waiting for an external action to know about the final refund status. Some refund methods are processed asynchronously or require the user to take some actions to complete the refund.
ERRORYAn error occurred while processing the refund.

Example

{
"class":"refund",
"id":64,
"reference":"998249",
"amount":5000,
"currency":"EUR",
"status":"SUCCESS",
"processing_time":1367488337,
"description":"goods could not be delivered",
"extra":"Q3VyaW9zaXR5IGlzIHRoZSBsdXN0IG9mIHRoZSBtaW5kLiAtIFRob21hcyBIb2JiZXMK",
"payment": { /* ... related payment object ... */ }
}