TRANSACTIONQUERY

  The following content assumes you have obtained the necessary PCI certification to process and submit sensitive cardholder data in the request to our Webservices API.
Read this article to learn more.

If you would like to retrieve information on requests and transactions you have previously submitted, you can submit a TRANSACTIONQUERY request.

 

Process overview

Your system will need to submit a TRANSACTIONQUERY request to Trust Payments. Trust Payments will then return a response containing the requested information, if a matching request has been found.

For example, you can request information on all transactions processed on your Site Reference between 6pm and 9pm, or find out whether or not a transaction has been settled.

 

Filters

The TRANSACTIONQUERY request consists primarily of filters. Think of filters as search criteria; the response returned will contain information meeting the specified filters.

For example, a filter with orderreference “100100” would return details of all matching requests with that reference (if any exist and have been processed on your site reference).

And specifying a starttimestamp and endtimestamp will return details of all requests processed on your account between the specified times.

  Multiple records can be returned in a single response

We recommend being as specific as reasonably possible in your request, by submitting as many filters as required, in order to avoid returning an excessive number of records in the response.

You can also submit multiple values for each given filter. e.g. You can submit a filter for transactionreference values “23-9-1” and “23-9-2”, and any requests matching these values will be returned in the response. (We include an example of this case below)

 

TRANSACTIONQUERY request

For the TRANSACTIONQUERY request to be processed successfully, you need to submit at least one valid filter.

 

Request example

Python PHP cURL Raw JSON Raw XML
#!/usr/bin/python
import securetrading

stconfig = securetrading.Config()
stconfig.username = "webservices@example.com"
stconfig.password = "Password1^"
st = securetrading.Api(stconfig)

query = {
"requesttypedescriptions": ["TRANSACTIONQUERY"],
"filter":{
"sitereference": [{"value":"test_site12345"}],
"currencyiso3a": [{"value":"GBP"}],
"transactionreference": [{"value":"23-9-1"},{"value":"23-9-2"}]
}
}

strequest = securetrading.Request()
strequest.update(query)
stresponse = st.process(strequest) #stresponse contains the transaction response

Replace <DOMAIN> with a supported domain. Click here for a full list.

 

Field specification

The following table lists all fields that you can include in the filter when processing a TRANSACTIONQUERY request.

  Although none of the following filter fields are required, at least one filter must be submitted for the request to be processed successfully. For this reason, most of the fields have been marked below as conditional.

An exception to this behaviour is the sitereference filter, which cannot be submitted on its own; it must be accompanied by at least one other filter. This restriction is enforced to reduce load on our servers.

  Field Format Description
table-conditional.png accounttypedescription
XPath: /filter/accounttypedescription
Alpha (20) The source of the transaction.
  • For an e-commerce AUTH Request, the value should be “ECOM”.
  • For Mail Order or Telephone Order (MOTO) requests, the value should be “MOTO”.
  • For a recurring transaction, the value should be “RECUR”.
table-conditional.png billingemail
XPath: /filter/billingemail
Email (255)

The customer’s billing email address.

Maximum length of 255 (maximum of 64 characters before the ”@” symbol).

table-conditional.png billingfirstname
XPath: /filter/billingfirstname
Alphanumeric including symbols (127) The customer’s billing first name.
table-conditional.png billinglastname
XPath: /filter/billinglastname
Alphanumeric including symbols (127) The customer’s billing last name.
table-conditional.png billingpostcode
XPath: /filter/billingpostcode
Alphanumeric including symbols (25) The billing postcode or ZIP code. This must be a valid postcode/ZIP code for the billingcountryiso2a submitted.
table-conditional.png billingpremise
XPath: /filter/billingpremise
Alphanumeric including symbols (20) The number or name of the premise of the customer’s billing address.
table-conditional.png billingstreet
XPath: /filter/billingstreet
Alphanumeric including symbols (20) The street name of the customer’s billing address.
table-conditional.png currencyiso3a
XPath: /filter/currencyiso3a
Alpha (3)

The transaction currency.

Click here for a full list of currency codes.

table-conditional.png customerip
XPath: /filter/customerip
IP address (39) The customer’s IP address.
table-conditional.png endtimestamp
XPath: /filter/endtimestamp
Date Time YYYY-MM-DD HH:MM:SS Only requests processed before the timestamp specified will be returned.

(Unlike with other filters, you can only submit one endtimestamp in a request)

table-conditional.png orderreference
XPath: /filter/orderreference
Alphanumeric including symbols (25) Unique reference number supplied by the merchant for the request.
table-conditional.png pan
XPath: /filter/pan
Numeric (12-19) This is the card number printed on the front of the customer’s card.
table-conditional.png parenttransactionreference
XPath: /filter/parenttransactionreference
Alphanumeric including hyphens (25) Unique reference of the parent request.
table-conditional.png paymenttypedescription
XPath: /filter/paymenttypedescription
Alpha (20) The customer’s card type (e.g. “VISA” or “MASTERCARD”).
table-conditional.png requesttypedescription
XPath: /filter/requesttypedescription
Alpha (20)

The request type associated with transaction. For example, “AUTH” or “REFUND”.

Click here for a full list of request types.

table-optional.png sitereference
XPath: /filter/sitereference
Alpha (50)

The site reference that processed the transaction.

The sitereference filter must be submitted with at least one other filter, otherwise an error will be returned.

table-conditional.png starttimestamp
XPath: /filter/starttimestamp
Date Time YYYY-MM-DD HH:MM:SS Only requests processed after the timestamp specified will be returned.

(Unlike with other filters, you can only submit one starttimestamp in a request)

table-conditional.png transactionreference
XPath: /filter/transactionreference
Alphanumeric including hyphens (25) The unique reference associated with the transaction, assigned by Trust Payments.

 

TRANSACTIONQUERY response

Once you have successfully submitted a TRANSACTIONQUERY request, you will be returned a response that is divided into separate records.

Each record will contain a varying number of response fields, which depend on the request type indicated in the record. For example, if the record has a requesttypedescription of “AUTH“, then you would need to refer to the field specification in the Authorisation.

Additionally, the response contains a field called found, which indicates the number of records that match the filters specified in the request. If found has a value of  “0”, no records have been found using your specified filters.

For example, here is a simplified example of the structure of the response, consisting of 2 records (both are type “AUTH”):

Python PHP Raw JSON Raw XML
{
u 'requestreference': u 'W72-pg3q2he9',
u 'version': u '1.00',
u 'responses': [{
u 'errorcode': u '0',
u 'errormessage': u 'Ok',
u 'found': u '2',
u 'records': [{
u 'accounttypedescription': u 'ECOM',
u 'acquirerresponsecode': u '00',
u 'authcode': u 'TEST22',
u 'baseamount': u '1050',
u 'cavv': u 'dHJ1c3RwYXltZW50c2F1dGhlbnQ',
u 'currencyiso3a': u 'GBP',
u 'dccenabled': u '0',
u 'debtrepayment': u '0',
u 'eci': u '05',
u 'enrolled': u 'Y',
u 'errorcode': u '0',
u 'errormessage': u 'Ok',
u 'expirydate': u '10/2022',
u 'fraudrating': u '0',
u 'interface': u 'PASS-JSON-JSON',
u 'issuer': u 'SecureTrading Test Issuer1',
u 'issuercountryiso2a': u 'US',
u 'livestatus': u '0',
u 'maskedpan': u '411111######1111',
u 'merchantcountryiso2a': u 'GB',
u 'merchantname': u 'Test Merchant',
u 'operatorname': u 'webservices@example.com',
u 'paymenttypedescription': u 'VISA',
u 'requesttypedescription': u 'AUTH',
u 'securityresponseaddress': u '0',
u 'securityresponsepostcode': u '0',
u 'securityresponsesecuritycode': u '2',
u 'settlebaseamount': u '1050',
u 'settleduedate': u '2019-12-17',
u 'settlestatus': u '0',
u 'sitereference': u 'test_site12345',
u 'splitfinalnumber': u '1',
u 'status': u 'Y',
u 'threedversion': u '2.2.0',
u 'tid': u '27882788',
u 'transactionreference': u '72-9-80005',
u 'transactionstartedtimestamp': u '2019-12-17 09:35:03'
}, {
u 'accounttypedescription': u 'ECOM',
u 'acquirerresponsecode': u '00',
u 'authcode': u 'TEST03',
u 'baseamount': u '1050',
u 'cavv': u 'dHJ1c3RwYXltZW50c2F1dGhlbnR',
u 'currencyiso3a': u 'GBP',
u 'dccenabled': u '0',
u 'debtrepayment': u '0',
u 'eci': u '05',
u 'enrolled': u 'Y',
u 'errorcode': u '0',
u 'errormessage': u 'Ok',
u 'expirydate': u '10/2022',
u 'fraudrating': u '0',
u 'interface': u 'PASS-JSON-JSON',
u 'issuer': u 'SecureTrading Test Issuer1',
u 'issuercountryiso2a': u 'US',
u 'livestatus': u '0',
u 'maskedpan': u '411111######1111',
u 'merchantcountryiso2a': u 'GB',
u 'merchantname': u 'Test Merchant',
u 'operatorname': u 'webservices@example.com',
u 'paymenttypedescription': u 'VISA',
u 'requesttypedescription': u 'AUTH',
u 'securityresponseaddress': u '0',
u 'securityresponsepostcode': u '0',
u 'securityresponsesecuritycode': u '2',
u 'settlebaseamount': u '1050',
u 'settleduedate': u '2019-12-17',
u 'settlestatus': u '0',
u 'sitereference': u 'test_site12345',
u 'splitfinalnumber': u '1',
u 'status': u 'Y',
u 'threedversion': u '2.2.0',
u 'tid': u '27882788',
u 'transactionreference': u '72-9-80006',
u 'transactionstartedtimestamp': u '2019-12-17 09:35:10'
}],
u 'requesttypedescription': u 'TRANSACTIONQUERY',
u 'transactionstartedtimestamp': u '2019-12-17 09:36:21'
}]
}

  A maximum of 500 records can be returned per response.

The found field will never return a value higher than 500, even if more than 500 requests meet the specified criteria.

 

Understanding errors

Please ensure you understand the Error Codes returned in the response:

  • At the highest level of the response, along with transactionstartedtimestamp and found, there is an errorcode. This indicates whether or not the TRANSACTIONQUERY request was successful. If the error code here is not “0”, the TRANSACTIONQUERY request was not successful. You must address the problem and try again.
  • In addition to this, each record will contain their own errorcode. This indicates whether or not the request represented in the record was successful.
  • For a full list of error codes used by Trust Payments, click here.

 

Field specification

The following table lists all fields that can be returned in a given record.

  Fields are only returned if the data is available for the request queried.
This can vary depending on request type.

  Field Format Description
table-returned.png accounttypedescription
XPath: /record/operation/accounttypedescription
Alpha (20) The type of account used to process the request queried:
  • “ECOM” – E-commerce.
  • “MOTO” – Mail or Telephone Order
  • “RECUR” – Recurring transactions
table-conditional.png

acquireradvicecode
XPath: /record/acquireradvicecode

 Numeric (1) A numeric value returned following a repeat payment request, indicating if further payments can be processed.

Mapping:

  • 0 – No action required.
  • 1 – New account information available.
  • 2 – Cannot approve at this time.
  • 4 – Do not process further recurring transactions.
  • 8 – Payment blocked by card scheme.

Whether this field is returned varies depending on your acquiring bank. Please contact our Support Team if you need assistance.

table-conditional.png

acquirerresponsecode
XPath: /record/acquirerresponsecode

Alphanumeric (255)

Used by your acquirer to indicate the outcome of the request queried.

Whether these fields are returned vary depending on your acquiring bank. Please contact our Support Team if you need assistance.

table-conditional.png

acquirerresponsemessage
XPath: /record/acquirerresponsemessage

Alphanumeric (255)
table-conditional.png authcode
XPath: /record/authcode
Alphanumeric (255)

The authorisation code provided by the issuing bank. This will differ depending on which bank you use.

Only returned if the queried transaction was authorised.

table-conditional.png authmethod
XPath: /record/operation/authmethod
Alpha (11)

Auth methods are used to specify how a transaction is to be processed by the card issuer. Each authmethod has a different set of requirements. Click the following links to learn more:

Only returned when an authmethod value has been assigned to the request.

table-returned.png baseamount
XPath: /record/billing/amount
Numeric (13) The amount of the transaction queried in base units, with no commas or decimal points, so £10 is submitted as 1000.
table-conditional.png billingcountryiso2a
XPath: /record/billing/country
Alpha (2)

The country for the customer’s billing address in ISO2A format.

Click here for a full list of country codes.

This field is returned if available.

table-conditional.png billingcounty
XPath: /record/billing/county
Alphanumeric including
symbols (127)

The county entered for the customer’s billing address. For US addresses, the state is returned here in a 2 character format (e.g. "NY").

This field is returned if available.

table-conditional.png billingemail
XPath: /record/billing/email
Email (255)

The customer’s billing email address.

This field is returned if available.

table-conditional.png billingfirstname
XPath: /record/billing/name/first
Alphanumeric including
symbols (127)

The customer’s billing first name.

This field is returned if available.

table-conditional.png billinglastname
XPath: /record/billing/name/last
Alphanumeric including
symbols (127)

The customer’s billing last name.

This field is returned if available.

table-conditional.png billingmiddlename
XPath: /record/billing/name/middle
Alphanumeric including
symbols (127)

The customer’s billing middle name(s).

This field is returned if available.

table-conditional.png billingpostcode
XPath: /record/billing/postcode
Alphanumeric (25)

The postcode entered for the customer’s billing address.

This field is returned if available.

table-conditional.png billingprefixname
XPath: /record/billing/name/prefix
Alphanumeric including
symbols (25)

The prefix of the customer’s billing name (e.g. Mr, Miss, Dr).

This field is returned if available.

table-conditional.png billingpremise
XPath: /record/billing/premise
Alphanumeric including
symbols (25)

The house number or first line of the customer’s billing address.

This field is returned if available.

table-conditional.png billingstreet
XPath: /record/billing/street
Alphanumeric including
symbols (127)

The street entered for the customer’s billing address.

This field is returned if available.

table-conditional.png billingsuffixname
XPath: /record/billing/name/suffix
Alphanumeric including
symbols (25)

The suffix of the customer’s billing name (e.g. Bsc).

This field is returned if available.

table-conditional.png billingtelephone
XPath: /record/billing/telephone
Alphanumeric including
symbols (20)

The customer’s telephone number.

This field is returned if available.

table-conditional.png billingtelephonetype
XPath: /record/billing/telephone/@type
Char (1) The type of telephone number. The options available are:
  • H = Home
  • M = Mobile
  • W = Work

This field is returned if available.

table-conditional.png billingtown
XPath: /record/billing/town
Alphanumeric including
symbols (127)

The town entered for the customer’s billing address.

This field is returned if available.

table-conditional.png cavv
XPath: /record/threedsecure/cavv
Alphanumeric (56)

The unique Cardholder Authentication Verification Value (CAVV) associated with the transaction.

This field is returned if available.

table-conditional.png chargedescription
XPath: /record/merchant/chargedescription
Alphanumeric including
symbols (25)

This is a description of the queried payment that appears on the customer’s bank statement.

This field is returned if available.

table-conditional.png credentialsonfile
XPath: /record/operation/credentialsonfile
Numeric (1) The allowed values for this field are 0, 1 and 2.
  • “0” – Not eligible for CoF, or no intention of re-using credentials at a later time.
  • “1” – Transaction credentials flagged as available for future use.
  • “2” – Payment using previously-stored credentials.

Only returned when a credentialsonfile value has been assigned to the request.

table-returned.png currencyiso3a
XPath: /record/billing/amount/@currencycode
Alpha (3)

The currency of the transaction queried.

Click here for a full list of available currencies.

table-conditional.png customercountryiso2a
XPath: /record/customer/country
Alpha (2)

The country for the customer’s delivery address in ISO2A format.

Click here for a full list of country codes.

This field is returned if available.

table-conditional.png customercounty
XPath: /record/customer/county
Alphanumeric including
symbols (127)

The county entered for the customer’s delivery address. For US addresses, the state is returned here in a 2 character format (e.g. "NY").

This field is returned if available.

table-conditional.png customeremail
XPath: /record/customer/email
Email (255)

The customer’s delivery email address.

This field is returned if available.

table-conditional.png customerfirstname
XPath: /record/customer/name/first
Alphanumeric including
symbols (127)

The customer’s delivery first name.

This field is returned if available.

table-returned.png customerip
XPath: /record/customer/ip
IP address (39) The IP of the customer.
table-conditional.png customerlastname
XPath: /record/customer/name/last
Alphanumeric including
symbols (127)

The customer’s delivery last name.

This field is returned if available.

table-conditional.png customermiddlename
XPath: /record/customer/name/middle
Alphanumeric including
symbols (127)

The customer’s delivery middle name(s).

This field is returned if available.

table-conditional.png customerpostcode
XPath: /record/customer/postcode
Alphanumeric (25)

The postcode entered for the customer’s delivery address.

This field is returned if available.

table-conditional.png customerprefixname
XPath: /record/customer/name/prefix
Alphanumeric including
symbols (25)

The prefix of the customer’s delivery name (e.g. Mr, Miss, Dr).

This field is returned if available.

table-conditional.png customerpremise
XPath: /record/customer/premise
Alphanumeric including
symbols (25)

The house number or first line of the customer’s delivery address.

This field is returned if available.

table-conditional.png customerstreet
XPath: /record/customer/street
Alphanumeric including
symbols (127)

The street entered for the customer’s delivery address.

This field is returned if available.

table-conditional.png customersuffixname
XPath: /record/customer/name/suffix
Alphanumeric including
symbols (25)

The suffix of the customer’s delivery name (e.g. Bsc).

This field is returned if available.

table-conditional.png customertelephone
XPath: /record/customer/telephone
Alphanumeric including
symbols (20)

The customer’s telephone number.

This field is returned if available.

table-conditional.png customertelephonetype
XPath: /record/customer/telephone/@type
Char (1) The type of telephone number. The options available are:
  • H = Home
  • M = Mobile
  • W = Work

This field is returned if available.

table-conditional.png customertown
XPath: /record/customer/town
Alphanumeric including
symbols (127)

The town entered for the customer’s delivery address.

This field is returned if available.

table-conditional.png dccenabled
XPath: /record/billing/dcc/@enabled
Numeric (1)

Indicates if your account is configured for DCC:
1= Yes
0 = No

Only returned for card transactions.

table-conditional.png debtrepayment
XPath: /record/merchant/debtrepayment
Numeric (1)

Indicates if transaction is flagged as debt repayment:

  • 1 – Transaction is flagged as debt repayment.
  • 0 – Transaction is not flagged as debt repayment.

Click here to learn more.

Only returned for card transactions.

table-conditional.png eci
XPath: /record/threedsecure/eci
Alphanumeric (2)

The ECI (E-Commerce Indicator) security level associated with the transaction.

Click here to learn more about possible ECI values.

table-conditional.png enrolled
XPath: /record/threedsecure/enrolled
Char (1)

Indicates whether or not the customer’s card is enrolled in a 3-D Secure scheme.

Click here to learn more.

table-returned.png errorcode
XPath: /record/error/code
Numeric (1-5) The error code should be used to determine whether the request(s) being queried was successful.
  • If the error code is “0” then the transaction was successful.
  • If the error code is not “0” then the transaction was not successful.

Click here for a full list of errorcode and message values.

table-conditional.png errordata
XPath: /record/error/data
Alphanumeric (255)

Additional information to help troubleshoot the error.

Only returned if there has been an error.

table-returned.png errormessage
XPath: /record/error/message
Alphanumeric (255) This provides a brief explanation as to the cause of the error.

For successful transactions, this is returned as “Ok”.

Click here for a full list of errorcode and message values.

table-conditional.png expirydate
XPath: /record/billing/payment/expirydate
Date MM/YYYY

The expiry date printed on the card.

Only returned for card transactions.

table-conditional.png fraudrating
XPath: /record/fraud/rating
Numeric (2)

This field pertains to our internal fraud checks, as documented in this article. This value represents the queried transaction's currently-assigned fraud rating.

This feature is opt in. If not enabled on your site reference, 0 will always be returned.

If you have opted in:

  • -1 indicates checks are pending.
  • The higher the fraud rating, the greater the number of suspicious characteristics that have been identified by our fraud system.
  • By default, we will notify you of transactions that have a fraud rating of 2 or higher.
  • By default, we will suspend all transactions that have a fraud rating of 5 or higher.

Click here to learn more.

Only returned for card transactions.

table-returned.png interface
XPath: /record/operation/interface
Alphanumeric including symbols (50)

Represents the interface through which the queried request was processed. The following are common examples:

  • "JWT-JWT-JWT" - JavaScript Library or Mobile SDK.
  • "MYST" - MyST (e.g. Refund, Virtual terminal or Payout terminal).
  • "PASS-JSON-JSON" - Webservices API using JSON markup.
  • "PASS-XML-XML" - Webservices API using XML markup.
table-conditional.png issuer
XPath: /record/billing/payment/issuer
Alphanumeric (255)

The customer’s card issuer.

Only returned for card transactions.

table-conditional.png issuercountryiso2a
XPath: /record/billing/payment/issuercountry
Alpha (2)

The country for the customer’s card issuer.
This will be in ISO2A format.

Click here for a full list of country codes.

Only returned for card transactions.

table-returned.png livestatus
XPath: /record/live
Numeric (1)
  • 0 – The queried transaction was processed using a test account.
  • 1 – The queried transaction was processed using a live account.
table-conditional.png

maskedpan
XPath: /record/billing/payment/pan

Alphanumeric including “#” (12-19)

If tokenisedpayment is not returned:
The maskedpan field represents the customer’s card number.

If tokenisedpayment is returned with value 1:
The maskedpan field represents the customer’s unique token number used to perform the queried transaction. The value of maskedpan field is masked in the response. Most of the number is intentionally obscured by “#” characters, e.g. 411111######0211.

Only returned for card transactions.

table-conditional.png merchantcategorycode
XPath: /record/merchant/merchantcategorycode
Alphanumeric (255)

These are details associated with the account used to process the queried transaction. To amend these fields, please contact our Support Team.

Values returned depends on your account configuration.

merchantcity
XPath: /record/merchant/merchantcity
Alphanumeric (127)
merchantcountryiso2a
XPath: /record/merchant/merchantcountryiso2a
Alpha (2)
merchantname
XPath: /record/merchant/merchantname
Alphanumeric (255)
merchantstatecode
XPath: /record/merchant/merchantstatecode
Alphanumeric (127)
merchantzipcode
XPath: /record/merchant/merchantzipcode
Alphanumeric (10)
table-returned.png operatorname
XPath: /record/merchant/operatorname
Alphanumeric (255) The value of this field contains the name of the user that processed the request.
table-conditional.png orderreference
XPath: /record/merchant/orderreference
Alphanumeric including
symbols (25)

The unique order reference for the request queried that is stored on the Trust Payments system.

This field is returned if available.

table-conditional.png parenttransactionreference
XPath: /record/operation/parenttransactionreference
Alphanumeric
& hyphens (25)

The transactionreference of a previous request, from which key details have been inherited in the request queried.

This field is returned if available.

table-returned.png paymenttypedescription
XPath: /record/billing/payment/@type
Alpha (20) Payment method (e.g. “VISA” or “MASTERCARD”).
table-returned.png requesttypedescription
XPath: /record/@type
Alpha (20) The type of request returned in the record.
table-conditional.png retrievalreferencenumber
XPath: /record/other/retrievalreferencenumber
Alphanumeric (255)

An ISO term. This is used to reference the source transaction.

This field is returned if available. This will vary depending on your acquiring bank. Please contact your bank for further information.

table-conditional.png scaexemptionindicator
XPath: /record/operation/scaexemptionindicator
Numeric (1)

Returned if queried transaction has been flagged as exempt from EMV 3DS. Click here to learn more.

The following values can be returned:
1 – Low value
2 – Transaction Risk Analysis
3 – Trusted Merchant
4 – Secure Corporate payment
5 – Delegated authentication  

table-conditional.png securityresponseaddress
XPath: /record/security/address
Numeric (1)

The result of AVS and Security Code Checks. These contain one of the following values:

  • 0 - Acquirer not provided with info required to perform this check.
  • 1 - Acquirer unable to perform checks on info provided.
  • 2 - Info provided by customer matches that found on card issuer's records.
  • 4 - Info provided by customer does NOT match that found on card issuer's records.

Click here to learn more.

These fields are returned if available.

table-conditional.png securityresponsepostcode
XPath: /record/security/postcode
Numeric (1)
table-conditional.png securityresponsesecuritycode
XPath: /record/security/securitycode
Numeric (1)
table-returned.png settlebaseamount
XPath: /record/settlement/settlebaseamount
Numeric (13)

The value of amount to be settled. The amount settled can be updated to be lower than the amount initially authorised using a TRANSACTIONUPDATE request.

table-returned.png settleduedate
XPath: /record/settlement/settleduedate
Date YYYY-MM-DD The date on which the queried transaction will be settled.
table-conditional.png settledtimestamp
XPath: /record/settlement/settledtimestamp
Date time YYYY-MM-DD hh:mm:ss

The date and time the queried transaction was settled.

Only returned if transaction if transaction has been settled.

table-returned.png settlestatus
XPath: /record/settlement/settlestatus
Numeric (3)

A numeric value used to indicate the progress of settlement regarding the queried transaction.

Click here for a full list of settlestatus values.

table-returned.png sitereference
XPath: /record/operation/sitereference
Alphanumeric
& underscore (50)

The site reference through which the queried request was processed.

table-conditional.png splitfinalnumber
XPath: /operation/splitfinalnumber
Numeric (2)

Total number of splits permitted.

If you are not performing Split shipment, this will be returned as 1.

Click here to learn more about Split shipment.

Only returned for card transactions.

table-conditional.png stan
XPath: /record/other/stan
ISO 8583

The STAN (System Trace Audit Number) associated with the transaction. This follows the ISO 8583 standard.

This field is returned if available.

table-conditional.png status
XPath: /record/threedsecure/status
Char (1)

Indicates whether or not the customer was authenticated on the card issuer’s ACS.

Click here to learn more.

table-conditional.png threedversion
XPath: /record/threedsecure/version
Numeric (6)

Version of 3-D Secure used to authenticate the payment. (e.g. “2.1.0”)

table-conditional.png tid
XPath: /record/merchant/tid
Alphanumeric (255)

The terminal ID used to process the queried transaction. This is accredited to your merchant number when we setup your account in our systems.

Whether this field is returned varies depending on your acquiring bank. Please contact our Support Team if you need assistance.

table-conditional.png tokenisedpayment
XPath: /record/billing/payment/pan/@tokenised
Numeric (1)

If this field is returned with value 1, this indicates the queried transaction was processed using a token.

This field is returned if available.

table-conditional.png tokentype
XPath: /record/billing/payment/pan/@tokentype
Alphanumeric (50)

Used to identify the type of token used for the queried payment (e.g. “VISATOKEN”).

This field is returned if available.

table-returned.png transactionreference
XPath: /record/transactionreference
Alphanumeric including
hyphens (25)
A unique reference for the queried transaction assigned by Trust Payments. You will need this reference to perform a refund or update the transaction.
table-returned.png transactionstartedtimestamp
XPath: /record/timestamp
Date time YYYY-MM-DD hh:mm:ss The time the queried transaction was processed.
table-conditional.png updatereason
XPath: /record/settlement/updatereason
Alphanumeric (255)

The most recent party to perform an update on the transaction returned. If the transaction was never updated after the initial request was sent, this field will not be populated. Common examples:

  • The username of user that performed the update.
  • "rulemanager" - Transaction was updated by our Rule manager.
  • "securitypolicy" - Transaction was updated as per the security policy on your account.
  • "settle" - Transaction was updated by our settlement engine.
  • "duplicate" - Transaction was deemed a duplicate and suspended by our duplicate checks.

This field is returned if available.

table-conditional.png walletdisplayname
XPath: /record/billing/payment/wallet/displayname
Alphanumeric (255)

This normally contains the last four digits of the customer’s card number (e.g. “1111”).

This field is returned if available.

table-conditional.png walletsource
XPath: /record/billing/payment/wallet/source
Alphanumeric (20)

Used to identify the type of wallet used for the queried payment (e.g. “APPLEPAY”).

This field is returned if available.

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