Refund
Object
| Name | Type | Mandatory | Description |
|---|---|---|---|
| class | string | Y | The type of object which is being returned. In this case it will be refund. |
| id | int | Y | The SysPay reference of the returned refund. |
| reference | string | Y | The Merchant refund identifier which was sent on in the request call. |
| amount | int | Y | The amount in cents. |
| currency | string | Y | The currency (ISO-4217). |
| status | string | Y | The refund status. See statuses. |
| processing_time | unix timestamp | Y | The time stamp of when the refund was processed. Null is returned if the transaction is still not complete. |
| description | string | N | The refund description which was sent on in the request call. |
| extra | string | N | The extra parameter which was sent on in the request call. |
| failure_category | string | N | When the operation fails, this parameter will include extra information about the error. See Failure categories. |
| payment | object | Y | The original payment object. See Payment object. |
Refund statuses
| Status | Final | Description |
|---|---|---|
| SUCCESS | Y | The refund has been completed successfully. |
| FAILED | Y | The refund has been refused. |
| WAITING | N | This 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. |
| ERROR | Y | An 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 ... */ }
}