Skip to main content

Operation

Object

NameTypeMandatoryDescription
classstringYThe type of object which is being returned. In this case it will be operation.
idintYThe SysPay reference of the returned operation.
feature_namestringYThe API ‘s name .
processing_timeunix timestampNWhen the payment has been processed or null if the transaction is still not complete.
operation_timeunix timestampNThe timestamp when the operation is created.
booking_timeunix timestampNThe timestamp when the token is created.
checking_inunix timestampNThe check_in date of the booking.
checking_outunix timestampNThe check_out date of the booking.
bookingstringNThe partner reference of the booking.
customerstringNThe customer first name combined with the last name.
payment_methodstringNA payment method-specific string that can be used to identify the payment method used.
schemestringNCredit card scheme.
typestringNType of operation. See types
amountstringNThe amount in cents.
currencystringNThe currency.
sourcestringNThe source of operation.
feeintNThe fee of the operation.
statusarrayNThe status of the operation. See statuses

Operation Types

TypeDescription
PAYMENTA single payment.
REFUNDRefund a payment.
PREAUTHORIZATIONThe payment request should be fully processed or only authorized.
CHARGEBACKForced transaction reversal.

Operation Statuses

StatusDescription
CANCELLEDThe operation attempt has been canceled by the user.
EXPIREDThe operation has been expired.
FAILEDThe operation has been refused.
OPENThe user needs to be sent to the given redirect url to complete the operation.
SUCCESSThe operation has been completed successfully.
TIMED_OUTthe operation is not finished on time.
WAITINGThis means we are waiting for an external action in order to know about the payment status.
AUTHORIZEDAnother attempt for a non-successful initial payment of a billing agreement.
VOIDEDCancellation of an AUTHORIZED operation.
ERRORAn 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
}