Field specification

Request fields

The following table defines the fields that can be submitted in the request:

Request Field Name Data Type Field Length Transaction Type Comment
siteid Numeric 10 All Unique identification code supplied by Trust Payments.
txndate Date 19 All Unique timestamp for the transaction. Format yyyy-MM- dd:HH:mm:ss
terminalserialnumber Alphanumeric 24 All The unique terminal identifier for the PED supplying the card details. This is the serial number of the PED.
type Alphanumeric 10 All Transaction Type.
amount Numeric 10 All The full amount for the transaction in the major and minor currency unit (e.g. Pounds and Pence).
topuptoken Alphanumeric 64 PreAuth A token that links the previous authorization to this one. Allows the funds reserved to be increased.
refid Alphanumeric 56 All A client generated site wide unique reference ID for this transaction.
wait y/n 1 PreAuth, Sale

Wait for the response from the Terminal.

Default is y. By setting this to ‘n’, a response will immediately be received. Subsequently the status of the transaction can be queried using the ‘status’ message.

linked y/n 1 Refund Set “linked” to “n” to process a non linked refund. By default all refunds are linked.

 

Response fields

The following table defines the fields that can be returned in the response:

Response Field Name Data Type Field Length Transaction Type Comment
siteid Numeric 10 All Unique identification code supplied by Trust Payments.
terminalserialnumber Alphanumeric 10 CapturePreAuth, Refund,
Sale, Void
The unique terminal identifier for the PED supplying the card details.
amount Numeric   PreAuth, Sale The full amount for the transaction in the major and minor currency unit (e.g. Pounds and Pence). Note, the amount may be different than the initial request amount.
resultcode Alphanumeric 12 All The result of the transaction from the acquirer. Possible values are:
  • Approved Declined Error
  • Connection Timeout Terminal Busy Cancelled
authcode Numeric 12 PreAuth, Sale The authorization code of the transaction.
refid Numeric 12 All The unique reference ID for this transaction.
status Alphanumeric 24 Status

The status of the transaction.

PROCESSING/COMPL ETE /FAILED

expiry Date 19 PreAuth The expiry time for the authorization. After this time it will not be possible to topup or capture. Format yyyy- MM-dd:HH:mm:ss
token Alphanumeric 256 Payout A token which can be used to process a payout to this card (gaming).
error Alphanumeric 56 All Information if a transaction occurred.
message Alphanumeric N/A PreAuth, Sale Response message from issuer when card is declined.
cardtype Alphanumeric N/A PreAuth, Sale Contains the card type used for this transaction.
receipt Alphanumeric N/A Capture, PreAuth, Refund, Sale Contains cardholder receipt data that can be used for printing on the ePOS.
merchantreceipt Alphanumeric N/A Capture, PreAuth, Refund, Sale Contains merchant receipt data that can be used for printing on the ePOS.

 

Key

The headers in the tables above are defined as follows:

Field Name Name of the parameter field element.
Data Type The data type of the element can be one of the following:
  • Alphanumeric
  • Numeric
  • DateTime
Field Length The field length defines the maximum number of characters allowed for that element.
Transaction Type The Transaction Type that requires this field.
Comment 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.

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request