Operation
Object
| Name | Type | Mandatory | Description |
|---|---|---|---|
| class | string | Y | The type of object which is being returned. In this case it will be operation. |
| id | int | Y | The SysPay reference of the returned operation. |
| feature_name | string | Y | The API ‘s name . |
| processing_time | unix timestamp | N | When the payment has been processed or null if the transaction is still not complete. |
| operation_time | unix timestamp | N | The timestamp when the operation is created. |
| booking_time | unix timestamp | N | The timestamp when the token is created. |
| checking_in | unix timestamp | N | The check_in date of the booking. |
| checking_out | unix timestamp | N | The check_out date of the booking. |
| booking | string | N | The partner reference of the booking. |
| customer | string | N | The customer first name combined with the last name. |
| payment_method | string | N | A payment method-specific string that can be used to identify the payment method used. |
| scheme | string | N | Credit card scheme. |
| type | string | N | Type of operation. See types |
| amount | string | N | The amount in cents. |
| currency | string | N | The currency. |
| source | string | N | The source of operation. |
| fee | int | N | The fee of the operation. |
| status | array | N | The status of the operation. See statuses |
Operation Types
| Type | Description |
|---|---|
| PAYMENT | A single payment. |
| REFUND | Refund a payment. |
| PREAUTHORIZATION | The payment request should be fully processed or only authorized. |
| CHARGEBACK | Forced transaction reversal. |
Operation Statuses
| Status | Description |
|---|---|
| CANCELLED | The operation attempt has been canceled by the user. |
| EXPIRED | The operation has been expired. |
| FAILED | The operation has been refused. |
| OPEN | The user needs to be sent to the given redirect url to complete the operation. |
| SUCCESS | The operation has been completed successfully. |
| TIMED_OUT | the operation is not finished on time. |
| WAITING | This means we are waiting for an external action in order to know about the payment status. |
| AUTHORIZED | Another attempt for a non-successful initial payment of a billing agreement. |
| VOIDED | Cancellation of an AUTHORIZED operation. |
| ERROR | An error occurred while processing the payment. |
Example
{
"class": "Operation",
"id": 247728,
"feature_name": "DemoShop Hotel",
"processing_time": "1714312839",
"operation_time": "1714312838",
"booking_time": "1714312838",
"checking_in": "1716249600",
"checking_out": "1716854400",
"booking": "662e5685c7108",
"customer": "John Doe",
"email": "john.doe+662e5685c5341@gmail.com",
"payment_method": "4531-71xx-xxxx-7004",
"scheme": null,
"type": "BillingAgreement",
"amount": null,
"currency": "EUR",
"source": "SysPay Partner",
"fee": null,
"status": "SUCCESS",
"rolling_reserve": null,
"reserve_release_time": null,
"cvco_reference": null,
"wallet": null
}