The following table defines the fields that can be submitted in the request:
|amount||Numeric||10||Capture, PreAuth, Refund, Sale, Void||The full amount for the transaction in main units (e.g. £20 would be submitted as "20.00").|
Submit linked with value "n" to process a non-linked refund.
(By default all refunds are linked)
|siteid||Numeric||10||All||Unique identification code supplied by Trust Payments.|
|terminalserialnumber||Alphanumeric||24||Capture, PreAuth, Refund, Sale, Void||The unique terminal identifier for the PIN Entry Device (PED) supplying the card details. This is the serial number of the PED.|
|topuptoken||Alphanumeric||64||PreAuth||(Optional) A token that links the previous authorisation to this one. Allows the funds reserved to be increased.|
|txndate||Date||19||All||Unique timestamp for the transaction. Format yyyy-MM- dd:HH:mm:ss|
|type||Alphanumeric||10||Capture, PreAuth, Refund, Sale, Void||
The type of request being submitted. Supported requests are:
The following two values can be submitted:
The status of the transaction can be queried by submitting a Status request.
The following table defines the fields that can be returned in the response:
|amount||Numeric||10||PreAuth, Refund, Sale||
The original full amount authorised for the transaction in main units (e.g. £20 would be returned as “20.00”).
Note: The amount may differ from that submitted in the request due to changes made by the customer during checkout (e.g. addition of a tip).
|authcode||Numeric||12||PreAuth, Sale, Status||The authorisation code of the transaction.|
|cardtype||Alphanumeric||N/A||PreAuth, Sale, Status||Contains the card type used for this transaction (e.g. "VISA").|
|error||Alphanumeric||56||All||The field returns details of an error if a request was not processed successfully. Click here for further info.|
The expiry date and time for the authorisation. After this time, it is not possible to topup or capture.
The final amount authorised for the transaction in main units (e.g. £20 would be returned as “20.00”).
Note: The finalamount will include any changes made by the customer during checkout (e.g. addition of a tip).
|last4||Numeric||4||PreAuth, Sale, Status||
The last 4 digits of the customer debit/credit card used to facilitate the transaction.
|merchantreceipt||Alphanumeric||N/A||Capture, PreAuth, Refund, Sale||Contains merchant receipt data that can be used for printing on the ePOS.|
|message||Alphanumeric||N/A||PreAuth, Sale||Response message from issuer when card is declined.|
|receipt||Alphanumeric||N/A||Capture, PreAuth, Refund, Sale||Contains cardholder receipt data that can be used for printing on the ePOS.|
The result of the transaction from the acquirer. Possible values are:
|siteid||Numeric||10||All||Unique code to identify the Trust Payments site used to process the request.|
|terminalserialnumber||Alphanumeric||10||PreAuth, Refund, Sale||The unique terminal identifier for the PIN Entry Device (PED) supplying the card details.|
|topuptoken||Alphanumeric||64||PreAuth||A token that links the previous authorisation to this one. Allows the funds reserved to be increased.|
The headers in the tables above are defined as follows:
|Field||Name of the parameter field element.|
The data type of the element can be one of the following:
|Length||The field length defines the maximum number of characters allowed for that element.|
|Type||The request type that requires this field.|
The information included in the comment field is additional information relating to the field.
Providing the reader with a clearer understanding of what should be included.