3DS API Field Specification

  Last updated: 

 

THREEDLOOKUP Request

Required Field Format Length Description
X1-EN.png requesttypedescription
XPath: /@type
Alpha

20

You must submit “THREEDLOOKUP” in this field.

X1-EN.png accounttypedescription
XPath: /operation/accounttypedescription
Alpha

20

You must submit "ECOM" (e-commerce) in this field.

X1-EN.png baseamount
XPath: /billing/amount
Numeric

13

The amount of the transaction in base units, with no commas or decimal points, so £10 is submitted as 1000. This value must be greater than zero. (Max length may vary depending on your acquiring bank – Contact your bank for further info)

X1-EN.png currencyiso3a
XPath: /billing/amount/@currencycode
Alpha

3

The currency of the transaction.

Click here for a full list of available currencies.

 

X1-EN.png expirydate
XPath: /billing/payment/expirydate
Date MM/YYYY

7

The expiry date printed on the card.

X1-EN.png pan
XPath: /billing/payment/pan
Numeric

12-19

This is the long number printed on the front of the customer’s card.

X1-EN.png sitereference
XPath: /operation/sitereference
Alphanumeric & underscore

50

Identifies your site on the Trust Payments system.

If you do not know your site reference, please contact our Support Team.

X3-EN.png applicationtype
XPath: /operation/applicationtype
Alpha

3

Submit one of the following supported values:

  • "APP" - Payment using a mobile app.
  • "WAP" - For browser-based payments.
X3-EN.png orderreference
XPath: /merchant/orderreference
Alphanumeric including symbols

25

Your unique order reference that can be stored on the Trust Payments system.

Recommended length 25 characters or less (exact length dependent on acquiring bank). Failure to adhere to this requirement may result in the text being truncated in the transaction.

X3-EN.png paymenttypedescription
XPath: /billing/payment/@type
Alpha

20

Submit one of the following supported values:

  • "AMEX"
  • "DELTA"
  • "ELECTRON"
  • "MAESTRO"
  • "MASTERCARD"
  • "MASTERCARDDEBIT"
  • "PURCHASING"
  • "VISA"

 

THREEDLOOKUP Response

Required Field Format Length Description
X4-EN.png requesttypedescription
XPath: /@type
Alpha

20

“THREEDLOOKUP” is returned in the response.
X4-EN.png cachetoken
XPath: /operation/cachetoken
Alphanumeric

64

Unique identifier that represents the customer's card details on Trust Payment's system. This must be included in the THREEDQUERY request (step 3). It is valid for 15 minutes from when the THREEDLOOKUP response is returned.
X4-EN.png debtrepayment
XPath: /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.
X4-EN.png errorcode
XPath: /error/code
Numeric

1-5

The error code should be used to determine if the request was successful or not.
  • 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.

X4-EN.png errormessage
XPath: /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.

X4-EN.png maskedpan
XPath: /billing/payment/pan
Alphanumeric including “#”

12-19

The maskedpan field represents the customer’s card number used to perform the transaction. The value of maskedpan field is masked in the response. Most of the number is intentionally obscured by “#” characters, e.g. 411111######0211.
X4-EN.png paymenttypedescription
XPath: /billing/payment/@type
Alpha

20

One of the following values can be returned:

  • "AMEX"
  • "DELTA"
  • "ELECTRON"
  • "MAESTRO"
  • "MASTERCARD"
  • "MASTERCARDDEBIT"
  • "PURCHASING"
  • "VISA"
X4-EN.png threednotificationurl
XPath: /threedsecure/notificationurl
URL

Not defined

This field is returned during 3-D Secure version 2 authentication. This can be ignored, as you will define your own threednotificationurl to be used in step 2.

X4-EN.png threedstransactionid
XPath: /threedsecure/transactionid
Alphanumeric including hyphens

36

Universally unique transaction identifier assigned by the 3DS Server to identify a single transaction.
X4-EN.png threedversion
XPath: /threedsecure/version
Numeric

6

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

X4-EN.png transactionstartedtimestamp
XPath: /timestamp
Date time YYYY-MM-DD hh:mm:ss

19

The time the request was processed.
X2-EN.png errordata
XPath: /error/data
Alphanumeric

255

Additional information to help troubleshoot the error.

Only returned if there has been an error.

X2-EN.png threedmethodurl
XPath: /threedsecure/methodurl
URL

Not defined

URL to which your 3D Server submits a HTTPS POST as part of upcoming step 2 (Method URL). This URL is provided by the ACS.

If threedmethodurl is not returned, but threedversion is returned with value 2.2.0 or higher, skip to step 3 (3-D Query).

 

THREEDQUERY Request

Required Field Format Length Description
X1-EN.png requesttypedescription
XPath: /@type
Alpha

20

You must submit “THREEDQUERY” in this field.

X1-EN.png accept
XPath: /customer/accept
Alphanumeric

1024

The exact content of the HTTP accept-header field as received from the cardholder’s user agent.

X1-EN.png accounttypedescription
XPath: /operation/accounttypedescription
Alpha

20

Submit "ECOM" (e-commerce) in this field.
X1-EN.png acquirerbin
XPath: /acquirer/acquirerbin
Alphanumeric

11

If you are using a Trust Payments (UK/FCA) acquiring account, submit one of the following values:

  • "456896" - Visa
  • "271708" – Mastercard
  • "10000000232" - American Express

If you are using a Trust Payments (Malta) acquiring account, submit one of the following values:

  • "408912" - Visa
  • "529786" - Mastercard
  • "10000000232" - American Express

  Only use the BINs above if processing the authorisation request via the TRU Connect gateway. For other acquirers/gateways, please ensure you contact them to confirm the correct BIN.
X1-EN.png baseamount
XPath: /billing/amount
Numeric

13

The amount of the transaction in base units, with no commas or decimal points, so £10 is submitted as 1000. This value must be greater than zero. (Max length may vary depending on your acquiring bank – Contact your bank for further info)
X1-EN.png browsercolordepth
XPath: /customer/browsercolordepth
Numeric

2

Value representing the bit depth of the colour palette for displaying images, in bits per pixel.

Accepted values:

  • 1
  • 4
  • 8
  • 15
  • 16
  • 24
  • 32
  • 48
X1-EN.png browserjavaenabled
XPath: /customer/browserjavaenabled
Boolean

5

Whether or not the customer's browser can execute Java.

Accepted values: true, false.

X1-EN.png browserjavascriptenabled
XPath: /customer/browserjavascriptenabled
Boolean

5

Whether or not the customer's browser can execute JavaScript.

Accepted values: true, false.

X1-EN.png browserlanguage
XPath: /customer/browserlanguage
Alpha

8

Value representing the browser language as defined in IETF BCP47.

X1-EN.png browserscreenheight
XPath: /customer/browserscreenheight
Numeric

6

Total height of the customer's screen in pixels.

Required for Visa Secure Data Field Mandate.

X1-EN.png browserscreenwidth
XPath: /customer/browserscreenwidth
Numeric

6

Total width of the customer's screen in pixels.

Required for Visa Secure Data Field Mandate.

X1-EN.png browsertz
XPath: /customer/browsertz
Numeric

5

Time-zone offset in minutes between UTC and the customer's browser local time.

Note that the offset is positive if the local time zone is behind UTC and negative if it is ahead.

e.g. If UTC -5 hours: 300 or +300

e.g. If UTC +5 hours: -300

X1-EN.png cachetoken
XPath: /operation/cachetoken
Alphanumeric

64

Unique identifier that represents the customer's card details on Trust Payment's system. It is valid for 15 minutes from when the THREEDLOOKUP response is returned.

This is returned to you in the THREEDLOOKUP response (step 1).

X1-EN.png

challengewindowsize
XPath: /customer/challengewindowsize

Numeric

2

Dimension of step-up authentication challenge pop-up window.

Accepted values:

  • 01 - For 250x400
  • 02 - For 390x400
  • 03 - For 500x600
  • 04 - For 600x400
  • 05 - For full screen
X1-EN.png currencyiso3a
XPath: /billing/amount/@currencycode
Alpha

3

The currency of the transaction.

Click here for a full list of available currencies.

X1-EN.png customerip
XPath: /customer/ip
IP address

39

The IP of the customer.

Required for Visa Secure Data Field Mandate.

X1-EN.png expirydate
XPath: /billing/payment/expirydate
Date MM/YYYY

7

The expiry date printed on the card.
X1-EN.png pan
XPath: /billing/payment/pan
Numeric

12-19

This is the long number printed on the front of the customer’s card.
X1-EN.png paymenttypedescription
XPath: /billing/payment/@type
Alpha

20

Submit one of the following supported values:

  • "AMEX"
  • "DELTA"
  • "ELECTRON"
  • "MAESTRO"
  • "MASTERCARD"
  • "MASTERCARDDEBIT"
  • "PURCHASING"
  • "VISA"
X1-EN.png sitereference
XPath: /operation/sitereference
Alphanumeric
& underscore

50

Identifies your site on the Trust Payments system.

If you do not know your site reference, please contact our Support Team.

X1-EN.png termurl
XPath: /merchant/termurl
URL

1024

This URL is used to instruct the card issuer where to send the customer’s browser after they have been authenticated on the card issuer’s ACS (for step-up authentication).
X1-EN.png threedscompind
XPath: /threedsecure/threedscompind
Char

1

Indicates whether the 3DS Method successfully completed.

Accepted values:

  • Y - Submit Y if step 2 (Method URL) was successfully completed.
  • N - Submit N if threedmethodurl and threednotificationurl were returned in THREEDLOOKUP but step 2 (Method URL) was skipped.
  • U - Submit U if threedmethodurl was not returned in THREEDLOOKUP.
X1-EN.png threedstransactionid
XPath: /threedsecure/transactionid
Alphanumeric including hyphens

36

Universally unique transaction identifier assigned by the 3DS Server to identify a single transaction.

This is returned to you in the THREEDLOOKUP response (step 1).

X1-EN.png useragent
XPath: /customer/useragent
Alphanumeric

2048

Exact content of the HTTP user-agent header. If length submitted exceeds max length 2048, the 3-D Secure server truncates the excess portion.
X2-EN.png billingemail
XPath: /billing/email
Email

255

The billing email address. This can then be used for correspondence with the customer. Maximum length of 255 (maximum of 64 characters before the”@” symbol).

Required for Visa Secure Data Field Mandate when billingtelephone is not provided.

X2-EN.png billingfirstname
XPath: /billing/name/first
Alphanumeric including symbols

127

The billing first name.

Required for Visa Secure Data Field Mandate.

X2-EN.png billinglastname
XPath: /billing/name/last
Alphanumeric including symbols

127

The billing last name.

Required for Visa Secure Data Field Mandate.

X2-EN.png billingtelephone
XPath: /billing/telephone
Alphanumeric including
symbols

20

The billing telephone number. Valid characters:
  • Numbers 0-9
  • Spaces
  • Special characters: + – ( )

Required for Visa Secure Data Field Mandate when billingemail is not provided.

X3-EN.png billingprefixname
XPath: /billing/name/prefix
Alphanumeric including
symbols

25

The billing name prefix, from the following list: Mr, Mrs, Miss, Dr, Ms, Prof, Rev, Sir, Lord, Lady, Dame & Mx.
X3-EN.png billingmiddlename
XPath: /billing/name/middle
Alphanumeric including
symbols

127

The billing middle name.
X3-EN.png billingsuffixname
XPath: /billing/name/suffix
Alphanumeric

25

The billing suffix name.
X3-EN.png billingpremise
XPath: /billing/premise
Alphanumeric including
symbols

25

The house number or first line of the billing address.
X3-EN.png billingstreet
XPath: /billing/street
Alphanumeric including
symbols

127

The street entered for the billing address.
X3-EN.png billingtown
XPath: /billing/town
Alphanumeric including
symbols

127

The town entered for the billing address.
X3-EN.png billingcounty
XPath: /billing/county
Alphanumeric including
symbols

127

The county entered for the billing address.

This is displayed as “State code (eg. NY)” on pages with "us_US" locale.

For US addresses, the state would be entered in this field.

Valid formats:

  • Preferred: Two character state code, e.g. “NY”.
  • Full state name (no abbreviations), e.g. “New York”.
X3-EN.png billingpostcode
XPath: /billing/postcode
Alphanumeric

25

The billing postcode or ZIP code. This must be a valid postcode/ZIP code for the billingcountryiso2a submitted.
X3-EN.png billingcountryiso2a
XPath: /billing/country
Alpha

2

The country entered for the billing address, using ISO2A format.
X3-EN.png billingtelephonetype
XPath: /billing/telephone/@type
Char

1

The type of telephone number entered. The options available are:
  • H = Home
  • M = Mobile
  • W = Work
X3-EN.png merchantcountryiso2a*
XPath: /merchant/merchantcountryiso2a
Alpha

2

Country code associated with your account.

If not submitted, we'll use the data stored in our records by default. Otherwise, you can submit this field to override this value on a per-request basis.

The information provided must match information used to register the account with Visa and Mastercard for 3-D Secure authentication.

X3-EN.png merchantcategorycode*
XPath: /merchant/merchantcategorycode
Numeric

4

Used to classify the type of goods and services offered by your business.

If not submitted, we'll use the data stored in our records by default. Otherwise, you can submit this field to override this value on a per-request basis.

The information provided must match information used to register the account with Visa and Mastercard for 3-D Secure authentication.

X3-EN.png merchantname*
XPath: /merchant/merchantname
Alphanumeric

255

Name associated with your account with Trust Payments.

If not submitted, we'll use the data stored in our records by default. Otherwise, you can submit this field to override this value on a per-request basis.

The information provided must match information used to register the account with Visa and Mastercard for 3-D Secure authentication.

X3-EN.png merchantnumber*
XPath: /merchant/merchantnumber
Alphanumeric

32

The merchant number that was used to process the transaction. Provided by the acquiring bank.

If not submitted, we'll use the data stored in our records by default. Otherwise, you can submit this field to override this value on a per-request basis.

The information provided must match information used to register the account with Visa and Mastercard for 3-D Secure authentication.

X3-EN.png orderreference
XPath: /merchant/orderreference
Alphanumeric including
symbols

25

Your unique order reference that can be stored on the Trust Payments system.

This field is returned if submitted in the request.

X3-EN.png requestorurl*
XPath: /merchant/requestorurl
URL

2048

Fully qualified URL of 3DS Requestor website or customer care site. This data element provides additional information to the receiving 3-D Secure system if a problem arises and should provide contact information.

If not submitted, we'll use the data stored in our records by default. Otherwise, you can submit this field to override this value on a per-request basis.

X3-EN.png trustpaymentsrequestoridmastercard*
XPath: /merchant/trustpaymentsrequestoridmastercard
Alphanumeric

26

The requestor id prefix "TRU93918", followed by “_”, and then the Merchant id (MID).
Example: "TRU93918_9991111111"

If not submitted, we'll use the data stored in our records by default. Otherwise, you can submit this field to override this value on a per-request basis.

The merchant id (MID) provided must match information used to register the account with Visa and Mastercard for 3-D Secure authentication.

X3-EN.png trustpaymentsrequestoridvisa*
XPath: /merchant/trustpaymentsrequestoridvisa
Alphanumeric

26

In our testing environment, your system will need to submit the requestor id prefix "11111111" followed by "*", and then the Merchant id (MID).

Example: "11111111*9991111111"

In a live environment, this would be the acquirer's Visa Bank id (BID) followed by "*", and then the MID provided by the merchant's acquirer.

If not submitted, we'll use the data stored in our records by default. Otherwise, you can submit this field to override this value on a per-request basis.

The merchant id (MID) provided must match information used to register the account with Visa and Mastercard for 3-D Secure authentication.

X3-EN.png trustpaymentsrequestornamemastercard*
XPath: /merchant/trustpaymentsrequestornamemastercard
Alphanumeric

40

Trust Payments assigned 3DS Requestor name for Mastercard, in the following format:

3DS Server name+"_"+Merchant name

e.g. "TrustPayments_Merchantname"

If not submitted, we'll use the data stored in our records by default. Otherwise, you can submit this field to override this value on a per-request basis.

The merchant name provided must match information used to register the account with Visa and Mastercard for 3-D Secure authentication.

X3-EN.png trustpaymentsrequestornamevisa*
XPath: /merchant/trustpaymentsrequestornamevisa
Alphanumeric

40

Merchant name that you define.

e.g. "Test Merchant1 Ltd"

If not submitted, we'll use the data stored in our records by default. Otherwise, you can submit this field to override this value on a per-request basis.

The merchant name provided must match information used to register the account with Visa and Mastercard for 3-D Secure authentication.

*If one of the following optional fields are submitted in the THREEDQUERY request, you must submit values for all of them.

  • merchantcategorycode
  • merchantcountryiso2a
  • merchantname
  • merchantnumber
  • trustpaymentsrequestoridmastercard
  • trustpaymentsrequestoridvisa
  • trustpaymentsrequestornamemastercard
  • trustpaymentsrequestornamevisa
  • requestorurl

 

THREEDQUERY Response

Required Field Format Length Description
X4-EN.png requesttypedescription
XPath: /@type
Alpha

20

"THREEDQUERY" is returned in the response.
X4-EN.png accounttypedescription
XPath: /operation/accounttypedescription
Alpha

20

"ECOM" (e-commerce) is returned in the response.
X4-EN.png acsreferencenumber
XPath: /threedsecure/acsreferencenumber
Alphanumeric

32

Unique identifier assigned to the ACS.
X4-EN.png acstransid
XPath: /threedsecure/acstransid
Alphanumeric

36

Unique identifier of the transaction within the ACS system.
X4-EN.png debtrepayment
XPath: /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.
X4-EN.png enrolled
XPath: /threedsecure/enrolled
Char

1

The payment card's enrolment status:

  • Y - The customer's card is enrolled.
  • N - The customer's card is not enrolled.
  • U - Unable to determine if card is enrolled.
  • B - Merchant authentication rule is triggered to bypass authentication in this use case.
X4-EN.png errorcode
XPath: /error/code
Numeric

1-5

The error code should be used to determine if the request was successful or not.
  • 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.

X4-EN.png errormessage
XPath: /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.

X4-EN.png issuer
XPath: /payment/issuer
Alphanumeric

255

The customer’s card issuer.
X4-EN.png issuercountryiso2a
XPath: /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.

X4-EN.png livestatus
XPath: /live
Numeric

1

  • 0 – Transaction processed using a test account.
  • 1 – Transaction processed using a live account.
X4-EN.png maskedpan
XPath: /billing/payment/pan
Alphanumeric including “#”

12-19

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

X4-EN.png merchantcategorycode
XPath: /merchant/merchantcategorycode
Alphanumeric

255

This is the merchant category code (MCC) associated with the account as defined in the request.

Values returned depends on your account configuration.

X4-EN.png merchantcountryiso2a
XPath: /merchant/merchantcountryiso2a
Alpha

2

This is the merchant country associated with the account as defined in the request.

Values returned depends on your account configuration.

X4-EN.png merchantname
XPath: /merchant/merchantname
Alphanumeric

255

This is the merchant name associated with the account as defined in the request.

Values returned depends on your account configuration.

X4-EN.png merchantnumber
XPath: /merchant/merchantnumber
Alphanumeric

32

This is the merchant number associated with the account as defined in the request.

Values returned depends on your account configuration.

X4-EN.png operatorname
XPath: /merchant/operatorname
Alphanumeirc

255

The value of this field contains the name of the user that processed the request.
X4-EN.png paymenttypedescription
XPath: /billing/payment/@type
Alpha

20

One of the following values can be returned:

  • "AMEX"
  • "DELTA"
  • "ELECTRON"
  • "MAESTRO"
  • "MASTERCARD"
  • "MASTERCARDDEBIT"
  • "PURCHASING"
  • "VISA"
X4-EN.png settleduedate
XPath: /settlement/settleduedate
Date YYYY-MM-DD

10

The date on which the transaction will be settled, if the subsequent payment is processed through the TRU Connect gateway, unless overridden in the AUTH.
X4-EN.png settlestatus
XPath: /settlement/settlestatus
Numeric

3

This is the assigned settlestatus value, in the event the subsequent payment is processed through the TRU Connect gateway, unless overridden in the AUTH. To learn more about settlestatus, click here.

X4-EN.png status
XPath: /threedsecure/status
Char

1

Indicates whether or not the customer was authenticated on the card issuer’s ACS:
  • Y – Customer authenticated. The information necessary to process a transaction will be included in this response. You can proceed straight to step 5 to process the THREEDRESULT request.
  • A – Authentication attempted but could not be completed. You can proceed straight to step 5 to process the THREEDRESULT request, but please note liability shift may not be available.
  • U – Unable to perform authentication. Liability shift will not be in effect. If opt to continue, proceed to step 5 to process the THREEDRESULT request.
  • N - Authentication was not successful. You must not proceed with payment.
  • C – Challenge required for authentication. Proceed to step 4 and complete step-up authentication.
  • R - Authentication was rejected. You must not proceed with payment.
X4-EN.png threedsservertransid
XPath: /threedsecure/threedsservertransid
Alphanumeric

36

Universally unique transaction identifier assigned for the 3-D Secure server to identify a single transaction.
X4-EN.png threedversion
XPath: /threedsecure/version
Numeric

6

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

X4-EN.png transactionreference
XPath: /transactionreference
Alphanumeric including hyphens

25

A unique reference for the transaction assigned by Trust Payments. You will need this reference to perform a refund or update the transaction.
X4-EN.png transactionstartedtimestamp
XPath: /timestamp
Date time YYYY-MM-DD hh:mm:ss

19

The time the request was processed.
X2-EN.png acquirerresponsecode
XPath: /acquirerresponsecode
Numeric

255

Contains information regarding errors returned during the 3-D Secure process.

Only returned in case of an error

X2-EN.png acquirerresponsemessage
XPath: /acquirerresponsemessage
Alphanumeric

255

Contains information regarding errors returned during the 3-D Secure process.

Only returned in case of an error

X2-EN.png acsurl
XPath: /threedsecure/acsurl
URL

1024

Only returned if status is C (indicating challenge).

Customer's browser needs to be redirected to this URL as part of step 4 (step-up authentication).

X2-EN.png errordata
XPath: /error/data
Alphanumeric

255

Additional information to help troubleshoot the error.

Only returned if there has been an error.

X2-EN.png orderreference
XPath: /merchant/orderreference
Alphanumeric including symbols

25

Your unique order reference that can be stored on the Trust Payments system.

This field is returned if submitted in the request.

X2-EN.png threedpayload
XPath: /threedsecure/threedpayload
Base64-encoded payload

N/A

Only returned if status is C (indicating challenge).

Contains info regarding the challenge user interface. To be passed to the ACS as part of step 4 (step-up authentication).

The value of the threedpayload is the creq required for step 4 (Challenge).

 

THREEDRESULT Request

Required Field Format Length Description
X1-EN.png parenttransactionreference
XPath: /operation/parenttransactionreference
Alphanumeric
& hyphens

25

You must submit the transactionreference value returned in the THREEDQUERY response.
X1-EN.png requesttypedescription
XPath: /@type
Alpha

20

You must submit “THREEDRESULT” in this field.
X1-EN.png sitereference
XPath: /operation/sitereference
Alphanumeric

50

Identifies your site on the Trust Payments system.

If you do not know your site reference, please contact our Support Team.

 

THREEDRESULT Response

Required Field Format Length Description
X4-EN.png requesttypedescription
XPath: /@type
Alpha

20

“THREEDRESULT” is returned in the response.
X4-EN.png accounttypedescription
XPath: /operation/accounttypedescription
Alpha

20

"ECOM" (e-commerce) is returned in the response.
X4-EN.png baseamount
XPath: /billing/amount
Numeric

13

The amount of the transaction in base units as submitted in the request, with no commas or decimal points, so £10 is submitted as 1000. (Max length may vary depending on your acquiring bank – Contact your bank for further info)

X4-EN.png cavv
XPath: /threedsecure/cavv
Alphanumeric

56

The unique Cardholder Authentication Verification Value (CAVV) associated with the transaction.
X4-EN.png currencyiso3a
XPath: /billing/amount/@currencycode
Alpha

3

The currency of the transaction.

Click here for a full list of available currencies.

X4-EN.png debtrepayment
XPath: /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.
X4-EN.png eci
XPath: /threedsecure/eci
Alphanumeric

2

The ECI (E-Commerce Indicator) security level associated with the transaction. Click here to learn more about possible ECI values.
X4-EN.png enrolled
XPath: /threedsecure/enrolled
Char

1

The payment card's enrolment status:

  • Y - The customer's card is enrolled.
  • N - The customer's card is not enrolled.
  • U - Unable to determine if card is enrolled.
  • B - Merchant authentication rule is triggered to bypass authentication in this use case.
X4-EN.png errorcode
XPath: /error/code
Numeric

1-5

The error code should be used to determine if the request was successful or not.
  • 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.

X4-EN.png errormessage
XPath: /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.

X4-EN.png issuer
XPath: /billing/payment/issuer
Alphanumeric

255

The customer’s card issuer.
X4-EN.png issuercountryiso2a
XPath: /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.

X4-EN.png livestatus
XPath: /live
Numeric

1

  • 0 – Transaction processed using a test account.
  • 1 – Transaction processed using a live account.
X4-EN.png maskedpan
XPath: /billing/payment/pan
Alphanumeric including “#”

12-19

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

X4-EN.png merchantcategorycode
XPath: /merchant/merchantcategorycode
Alphanumeric

255

This is the merchant category code (MCC) associated with the account as defined in the request.

Values returned depends on your account configuration.

X4-EN.png merchantcountryiso2a
XPath: /merchant/merchantcountryiso2a
Alpha

2

This is the merchant country associated with the account as defined in the request.

Values returned depends on your account configuration.

X4-EN.png merchantname
XPath: /merchant/merchantname
Alphanumeric

255

This is the merchant name associated with the account as defined in the request.

Values returned depends on your account configuration.

X4-EN.png merchantnumber
XPath: /merchant/merchantnumber
Alphanumeric

32

The merchant number that was used to process the request. Provided by the acquiring bank.
X4-EN.png operatorname
XPath: /merchant/operatorname
Alphanumeric

255

The value of this field contains the name of the user that processed the request.
X4-EN.png parenttransactionreference
XPath: /operation/parenttransactionreference
Alphanumeric
& hyphens

25

The value returned will match the parenttransactionreference included in the THREEDRESULT request.
X4-EN.png paymenttypedescription
XPath: /billing/payment/@type
Alpha

20

One of the following values can be returned:

  • "AMEX"
  • "DELTA"
  • "ELECTRON"
  • "MAESTRO"
  • "MASTERCARD"
  • "MASTERCARDDEBIT"
  • "PURCHASING"
  • "VISA"
X4-EN.png settleduedate
XPath: /settlement/settleduedate
Date YYYY-MM-DD

10

The date on which the transaction will be settled, if the subsequent payment is processed through the TRU Connect gateway, unless overridden in the AUTH.
X4-EN.png status
XPath: /threedsecure/status
Char

1

Indicates whether or not the customer was authenticated on the card issuer’s ACS:
  • Y – Customer authenticated. You can proceed to step 6 (Authorisation) and process a payment using the fields returned in this response.
  • A – Authentication attempted but could not be completed. You can proceed to step 6 (Authorisation) and process a payment using the fields returned in this response, but please note liability shift may not be available.
  • U – Unable to perform authentication. You can opt to process the payment but liability shift will not be in effect.
  • N - Authentication was not successful. You must not proceed with payment.
  • R - Authentication was rejected. You must not proceed with payment.
X4-EN.png threeddirectorytransactionreference
XPath: /threedsecure/directorytransactionreference
Alphanumeric

48

Unique DSTransactionId returned by your MPI provider.
X4-EN.png threedversion
XPath: /threedsecure/version
Numeric

6

Version of 3-D Secure used to authenticate the payment. (e.g. “2.2.0”)
X4-EN.png transactionreference
XPath: /transactionreference
Alphanumeric including
hyphens

25

A unique reference for the transaction assigned by Trust Payments. You will need this reference to perform a refund or update the transaction.
X4-EN.png transactionstartedtimestamp
XPath: /timestamp
Date time YYYY-MM-DD hh:mm:ss

19

The time the transaction was processed.
X2-EN.png errordata
XPath: /error/data
Alphanumeric

255

Additional information to help troubleshoot the error.

Only returned if there has been an error.

X2-EN.png orderreference
XPath: /merchant/orderreference
Alphanumeric including
symbols (25)

25

Your unique order reference that can be stored on the Trust Payments system.

This field is returned if submitted in the request.

 

Was this article helpful?
0 out of 0 found this helpful