Payment

Object

Name	Type	Mandatory	Description
class	string	Y	The type of object which is being returned. In this case it will be payment.
id	int	Y	The SysPay reference of the returned payment.
reference	string	Y	The merchant payment identifier which was passed in the request.
amount	int	Y	The amount in cents.
currency	string	Y	The currency (ISO-4217).
status	string	Y	The payment status .See statuses.
preauth_expiration_date	unix timestamp	Y	The preauth expiration date specifies until when a a preauth can be captured or voided or null. Please note that the transaction will be voided automatically once the preauth expires.
capture_date	unix timestamp	Y	The date after which the preauth may be automatically captured or null.
action_url	string	Y	The url where the customer should be redirected to in order to complete the operation or null if no redirection is requested.
flow	string	Y	The flow used to process the payment.
processing_time	unix timestamp	Y	When the payment has been processed, null if the transaction is still not complete.
source	int	Y	The id of the website the payment has been made for.
contract	string	Y	The name of the payment processor. This will be null until the payment has been processed.
descriptor	string	Y	The payment description which will be shown on the card payment bank statement. This will be null until the payment has been processed.
extra	string	N	The extra parameter which was sent on in the request call.
description	string	N	The merchant payment description.
account_id	int	Y	The SysPay account reference that the API access is linked to.
merchant_id	int	Y	The SysPay API access merchant reference.
merchant_login	string	Y	The SysPay API merchant login which processed the payment.
settlement_date	unix timestamp	Y	A timestamp indicating when this payment will be settled. This will be null until the payment has been processed.
failure_category	string	Y	When an operation fails, this parameter will include extra information about the error. See Failure categories. This will be null until the payment has been processed and if the payment is successfuly processed.
failure_message	string	Y	When an operation fails, this parameter will include extra information about the error. This will be null until the payment has been processed and if the payment is successfully processed.
chip_and_pin_status	string	Y	This field will be present on Chip&Pin transactions or null if it is not the case. When the payment has been made using Chip&Pin device, the actual payment status will be kept OPEN until the transaction is really captured. In order to let your web shop or native application know about the transaction results synchronously, this field will reflect the status seen on the device (SUCCESS / FAILED). This should be used for display purpose only.
token	object	Y	The token details. See Token object or null if no token is linked to it.
customer	object	Y	The customer details. See Customer object.
payment_method	object	Y	The payment method details. See Payment_method object.
processor_reference	string	Y	The reference of the transaction for the processor, in case of supergateway processing. This will be null until the payment has been processed.
qr_code	string	Y	This will be null if the payment method is not ANCV or if the ANCV account holder is unknown when the payment is initialized.
authentification_3ds	object	Y	The 3ds authentication details. See authentication 3ds object. This will be null until the payment has been processed.

Payment statuses

Status	Final	Description
OPEN	N	The user needs to be sent to the given redirect url to complete the payment.
SUCCESS	Y	The payment has been completed successfully
FAILED	Y	The payment has been refused. The response will come with a failure_category property that will provide you with more details about the failure whenever this is possible
CANCELLED	Y	The payment attempt has been canceled by the user
AUTHORIZED	N	When doing a 2-step payment (pre-authorization followed by a confirmation), this is the status the payment will be in after the authorization has taken place. It can now be confirmed (which will pass the payment to SUCCESS) or voided
VOIDED	Y	Cancellation of an AUTHORIZED payment. This will release the money to the card
WAITING	N	This means we are waiting for an external action in order to know about the payment status. Some payment methods are processed asynchronously or require the user to take some actions (like printing and sending a form) to complete the payment. You will know about the final status of the operation by receiving a payment notification
ERROR	Y	An error occurred while processing the payment
TIMED_OUT	Y	The token has been cancelled because no card details were provided before the accept_until parameter date.
EXPIRED	Y	The authorized payment has expired because it was not captured or voided.

Example

{
    "class":"payment",
    "id":16,
    "reference":"Unqiue-111111",
    "amount":5000,
    "currency":"EUR",
    "status":"SUCCESS",
    "preauth_expiration_date":"1421426671",
    "action_url": null,
    "flow":"API",
    "processing_time":1423501843,
    "website":1,
    "contract":"Contract",
    "descriptor":"Contract",
    "extra":null,
    "description":"Shopping basket payment",
    "account_id":123,
    "merchant_id":123,
    "merchant_login":"login",
    "settlement_date":1424711442,
    "failure_category":null,
    "failure_message":null,
    "chip_and_pin_status":null,
    "token":{
        "class":"token",
        "id":7,
        "status":"ACTIVE",
        "action_url":null,
        "booking_id":"test-ref",
        "check_in_date":"2015-08-22",
        "check_out_date":"2015-08-24",
        "expiration_date":1421426671,
        "customer":{
            "class":"customer",
            "email":"test@domain.com",
            "language":"en"
        },
        "payment_method":{
            "class":"payment_method",
            "type":"CREDITCARD",
            "display":"4111-11xx-xxxx-1111",
            "validation_status": "VALID",
            "validation_date":"1443607554",
            "invalid_reason": null,
            "details":{
                "class":"payment_method_details",
                "holder":"Card Holder Name",
                "scheme": "VISA",
                "exp_month":"01",
                "exp_year":"2016"
            }
        }
    },
    "customer":{
        "class":"customer",
        "email":"test@domain.com",
        "language":"en"
    },
    "payment_method":{
        "class":"payment_method",
        "type":"CREDITCARD",
        "display":"4111-11xx-xxxx-1111",
        "validation_status": "VALID",
        "validation_date":"1443607554",
        "invalid_reason": null,
        "details":{
            "class":"payment_method_details",
            "holder":"Card Holder Name",
            "scheme": "VISA",
            "exp_month":"01",
            "exp_year":"2016"
        }
    },
    "processor_reference":"ref1234"
}