Trust Payments may add additional attributes to blocks and fields in future updates. You must ensure your solution is able to support such changes.
Blocks
The following table describes the blocks that can be included when writing HTML to customise your Payment Pages.
| Not all blocks are supported on all pages. Blocks that are not supported on a given page are indicated in the table below with a cross: | |
| Blocks that are supported on a given page are indicated with a tick: |
|
| Some blocks are Required on a given page. These are highlighted in yellow, like so:
Note: Some blocks are only required in certain conditions. These are shown with the word Conditional. Hover your cursor over this label for further information. |
Required |
Useful resources
| Block |
Ability to include on each page |
||||
| Choice | Details | Locked | 3-D Redirect | Response | |
|
{{st.block.3dredirectdiv}}
This block handles the redirect to 3-D Secure. |
|||||
|
{{st.block.billingdetailsdivcountystatedropdown}}
This block is used to display the customer billing details input. If the Billing country is set to United States, the Billing county field will automatically change to be a State drop-down when rendered on the page. |
|||||
|
{{st.block.billingdetailsdiv}}
This block is used to display the customer billing details input. |
|||||
|
{{st.block.billingresponsediv}}
This block includes the billing response details. |
|||||
|
{{st.block.currencydetailsdiv}}
This block is used to display the DCC option details. |
|||||
|
{{st.block.currencyresponsediv}}
This block includes the DCC currency response details. |
|||||
|
{{st.block.defaultcss}}
This block ensures the page will use the Trust Payments default CSS. |
|||||
|
{{st.block.defaultjs}}
This block ensures the page will use the Trust Payments default JavaScript. |
|||||
|
{{st.block.deliverydetailsdivcountystatedropdown}}
This block is used to display the customer details input. If the Delivery country is set to United States, the Delivery county field will automatically change to be a State drop-down when rendered on the page. |
|||||
|
{{st.block.deliverydetailsdiv}}
This block is used to display the customer details input. |
|||||
|
{{st.block.deliveryresponsediv}}
This block includes the delivery response details. |
|||||
|
{{st.block.doctype}}
This block contains the HTML DOCTYPE declaration. |
|||||
|
{{st.block.footer}}
This block is used to display the Trust Payments footer. |
|||||
|
{{st.block.header}}
This block is used to display the Trust Payments header. |
Required | Required | Required | Required | Required |
|
{{st.block.hiddendiv}}
This block contains session information required to ensure successful transactions. |
Conditional | Required | Required | ||
|
{{st.block.lockeddiv}}
This block is used to display the processing payment message. |
|||||
|
{{st.block.messagesdiv}}
This block is used to display any success, warning or error messages to the customer during payment. |
|||||
|
{{st.block.metatags}}
This block contains the metadata information about the HTML page which is required by Trust Payments. |
|||||
|
{{st.block.orderdetailsdiv}}
This block is used to display the order information. |
|||||
|
{{st.block.paymentdetailsdiv}}
This block is used to display the customer payment details input. |
|||||
|
{{st.block.processingpaymentdiv}}
This block is used to display the processing payment message. |
|||||
|
{{st.block.profilecss}}
This block ensures the uploaded CSS provided by the merchant for the specified profile is used. |
|||||
|
{{st.block.profilejs}}
This block ensures the uploaded JavaScript provided by the merchant for the specified profile is used. |
|||||
|
{{st.block.requiredjs}}
Required on new integrations for correct operation of features such as 3-D Secure v2 and supported digital wallets. |
Required | Required | Required | ||
|
{{st.block.requirednoticediv}}
This block is used to display the key text for the asterisk’s displayed on the page. |
|||||
|
{{st.block.smallpaymentchoicesdiv}}
This block is used to display small clickable payment type logos for each of the payment types on the merchant account. |
Conditional | ||||
|
{{st.block.standardpaymentchoicesdiv}}
This block is used to display standard clickable payment type logos for each of the payment types on the merchant account. |
Conditional | ||||
|
{{st.block.transactionresponsediv}}
This block includes the transaction response details. |
|||||
Fields
| Field | Description |
| accept |
The exact content of the HTTP accept-header field as received from the cardholder’s user agent. Can be displayed as a value |
| accounttypedescription |
The type of account the request is processed through (e.g. “ECOM”, “MOTO”). Can be displayed as a value |
| achaba |
ACH-specific field: Transit routing number. Can be displayed as a value |
| achaccountnumber |
ACH-specific field: Account number. Can be displayed as a value |
| achchecknumber |
ACH-specific field: Check number for Point of Sale transactions. Length can be between 1 and 10. Can be displayed as a value |
| achtype |
ACH-specific field: Account type. Either “SAVINGS”, “CHECKING” or “BUSINESSCK”. Can be displayed as a value |
| acquirerresponsecode |
Response code specific to the acquirer. Can be displayed as a value |
| acquirerresponsemessage |
Message returned from the acquirer. Can be displayed as a value |
| acquirertransactionreference |
Unique transaction reference assigned by the acquirer. Can be displayed as a value |
| acquirertypedescription |
The acquirer name, e.g. “BANKOFAMERICA”. Can be displayed as a value |
| acsurl |
The URL of the Access Control Server to be used in authenticating the cardholder. Supplied if enrolled is “Y”. Can be displayed as a value |
| authcode |
The authorisation code is provided by the card issuer on authorisation. Can be displayed as a value |
| ban |
Bank transfer-specific field: Customer’s bank account number. Can be displayed as a value |
| bankid |
Bank transfer-specific field: Customer’s bank id. Can be displayed as a value |
| bankname |
Bank transfer-specific field: Name of the customer’s bank. Can be displayed as a value |
| baseamount |
The amount in base units with no commas or decimal points. For example £10.50 in base units is “1050”. Can be displayed as a value |
| bic |
Valid BIC (Bank Identifier Code) of customer’s bank. Can be displayed as a value |
| billingalias |
An alias provided by you, to identify the customer (required for certain Alternative Payment Methods). Can be displayed as a value |
| billingcountryiso2a |
Two digit country code for the billing address. For a list of country codes, click here. Can be displayed as a value |
| billingcounty |
County for the billing address. Can be displayed as a value |
| billingdob |
Date of birth of the account-holder. Can be displayed as a value |
| billingdobday |
Date of birth of the account-holder (the day). Can be displayed as a value |
| billingdobmonth |
Date of birth of the account-holder (the month). Can be displayed as a value |
| billingdobyear |
Date of birth of the account-holder (the year). Can be displayed as a value |
| billingemail |
Email address for billing. Can be displayed as a value |
| billingfirstname |
First name for billing details. Can be displayed as a value |
| billingid |
An id provided by you, used to identify the customer (required for certain Alternative Payment Methods). Can be displayed as a value |
| billinglastname |
Last Name for billing details. Can be displayed as a value |
| billingmiddlename |
Middle name or initial for billing details. Can be displayed as a value |
| billingpostcode |
The postcode for the billing address. Can be displayed as a value |
| billingprefixname |
Billing Name Prefix. For example, “Mr”, “Mrs”, “Miss”, “Dr”. Can be displayed as a value |
| billingpremise |
The first line of the billing address. Can be displayed as a value |
| billingstreet |
The street name of the billing address. Can be displayed as a value |
| billingsuffixname |
Billing name suffix. For example “Phd”, “BSc MEng”. Can be displayed as a value |
| billingtelephone |
The telephone number for the billing address. Can be displayed as a value |
| billingtelephonetype |
This is an attribute for the telephone number. The options available are: “H” = Home, “M” = Mobile, “W” = Work. Can be displayed as a value |
| billingtown |
The town of the billing address. Can be displayed as a value |
| cancelurl |
The URL that the customer will be returned to if they cancel the authorisation on their PayPal account. Can be displayed as a value |
| cavv |
CAVV of a transaction. Can be displayed as a value |
| chargedescription |
Basic description of the transaction that is shown on the customer’s bank statement. Can be displayed as a value |
| credentialsonfile | The allowed values for this field are 0, 1 and 2.
Can be displayed as a value |
| currencyiso3a |
The currency in 3 character format. For a list of currencies, click here. Can be displayed as a value |
| customeraccountnumber |
If account number type is “ACCOUNT”, the account holder’s account number. If account number type is “CARD” the account holder’s card number (UK-based debt repayment accounts only). Can be displayed as a value |
| customeraccountnumbertype |
Either “CARD” or “ACCOUNT”. (UK-based debt repayment accounts only). Can be displayed as a value |
| customercountryiso2a |
Two digit country code for the customer address. For a list of country codes, click here. Can be displayed as a value |
| customercounty |
County for the customer address. Can be displayed as a value |
| customerdob |
Customer Date of Birth in the format YYYY-MM-DD. Can be displayed as a value |
| customerdobday |
Customer Date of Birth (the day). Can be displayed as a value |
| customerdobmonth |
Customer Date of Birth (the month). Can be displayed as a value |
| customerdobyear |
Customer Date of Birth (the year). Can be displayed as a value |
| customeremail |
The customer’s email address. Can be displayed as a value |
| customerfirstname |
The customer’s first name. Can be displayed as a value |
| customerip |
The IP of the customer. Can be displayed as a value |
| customerlastname |
The customer’s last name. Can be displayed as a value |
| customermiddlename |
The customer’s middle name. Can be displayed as a value |
| customeroutput |
Reserved keyword. Can be displayed as a value |
| customerpostcode |
The customer’s address postcode. Can be displayed as a value |
| customerprefixname |
The prefix of the customer’s name (e.g. “Mr”, “Miss”, “Dr”). Can be displayed as a value |
| customerpremise |
The customer’s address premise (house name or number). Can be displayed as a value |
| customerredirecturl |
Redirect the customer’s browser to this URL so they can continue with the payment. Can be displayed as a value |
| customerstreet |
The customer’s address street name. Can be displayed as a value |
| customersuffixname |
The suffix of the customer’s name (e.g. “Bsc”). Can be displayed as a value |
| customertelephone |
The customer’s telephone number. Can be displayed as a value |
| customertelephonetype |
This is an attribute for the telephone number. The options available are: “H” = Home, “M” = Mobile, “W” = Work. Can be displayed as a value |
| customertown |
The town of the customer’s address. Can be displayed as a value |
| dccbaseamount |
DCC-specific: The amount you would like to be credited in the Merchant’s Currency. This amount in base units with no decimal points, so £10.50 would be “1050”. Can be displayed as a value |
| dccconversionrate |
DCC-specific: The conversion rate used to calculate the amount in the Customer’s Currency. Can be displayed as a value |
| dccconversionratesource |
DCC-specific: The source of the conversion rate returned from the DCC provider. Can be displayed as a value |
| dcccurrencyiso3a |
DCC-specific: The Merchant’s Currency in iso3a format. Can be displayed as a value |
| dccenabled |
DCC-specific: Indicates if the transaction was processed using DCC. “1”= Yes, “0” = No. Can be displayed as a value |
| dccexpirytimestamp |
DCC-specific: The expiry date of the CURRENCYRATE look-up. Subsequent requests using the CURRENCYRATE as a parent must settle before this date and time. Format: YYYY-MM-DD HH:MM:SS. Can be displayed as a value |
| dccmainamount |
DCC-specific: The amount you would like to be credited in the Merchant’s Currency. This amount in main units, with decimal points, so £10.50 would be “10.50”. Can be displayed as a value |
| dccmarginratepercentage |
DCC-specific: The percentage used to calculate the currency conversion fee (4 decimal places), automatically added to the amount in the Customer’s Currency by the DCC provider. Can be displayed as a value |
| dccoffered |
DCC-specific: The following values can be returned:
Can be displayed as a value |
| dccprovider |
DCC-specific: The name of the third-party DCC provider that has provided the conversion rate used in the payment. Can be displayed as a value |
| dccproviderdata |
DCC-specific: A unique string that contains information on the calculated conversion rate, returned directly from certain conversion rate providers. Can be displayed as a value |
| dccratio |
DCC-specific: The ratio between the amount in the Customer’s Currency and the amount in the Merchant’s Currency, processed in the request in main units. Can be displayed as a value |
| dcctype |
DCC-specific: Either “DCC” or “CPC”. Can be displayed as a value |
| debtrepayment | Indicates if transaction is flagged as debt repayment:
1 – Transaction is flagged as debt repayment. 0 – Transaction is not flagged as debt repayment. Can be displayed as a value |
| englishacquirertypedescription |
Name of the bank. Can be displayed as a value |
| enrolled |
Whether or not the customer’s card is enrolled in 3-D Secure. Can be displayed as a value |
| errorcode |
A code to indicate result of the transaction. The code will be “0” if the transaction was successful. Can be displayed as a value |
| errordata |
Additional information to help troubleshoot an error. Can be displayed as a value |
| errormessage |
A text description to indicate the result of the transaction. The message will be “Ok” if the transaction was successful. Can be displayed as a value |
| expirydate |
The expiry date printed on the card. Can be displayed as a value |
| expirymonth |
The month of the expiry date printed on the card. Can be displayed as a value |
| expiryyear |
The year of the expiry date printed on the card. Can be displayed as a value |
| extendedchargedescription |
The extended charge description. Can be displayed as a value |
| facilitatorid |
The payment facilitator id assigned by Mastercard at time of registration. Can be displayed as a value |
| facilitatorname |
The payment facilitator name agreed with Mastercard. Can be displayed as a value |
| found |
The number of records that match the filters specified in the TRANSACTIONQUERY request. Can be displayed as a value |
| iban |
Bank transfer-specific field: Customer’s international bank account number. Can be displayed as a value |
| independentsalesorgid |
The ISO (Independent Sales Organisation) id assigned by Mastercard at time of registration. Can be displayed as a value |
| initiationreason | These are the values we currently support:
Can be displayed as a value |
| issuenumber |
The issue number printed on the card. Can be displayed as a value |
| issuer |
The card issuer. Can be displayed as a value |
| issuercountryiso2a |
Two digit country code for the card issuer. For a list of country codes, click here. Can be displayed as a value |
| livestatus |
This will indicate if the transaction was on the live system (“1”) or in test mode (“0”). Can be displayed as a value |
| locale |
We will use the value of this field when rendering the page, to ensure the correct language is displayed to the customer. Can be displayed as a value |
| mainamount |
This amount in main units, with decimal points, so £10.50 would be “10.50”. Can be displayed as a value |
| mandatereference |
Unique reference that identifies each direct debit. Can be displayed as a value |
| maskedachaba |
ACH-specific field: Masked transit routing number. Can be displayed as a value |
| maskedachaccountnumber |
ACH-specific field: Masked account number. Can be displayed as a value |
| maskedban |
Bank transfer-specific field: Masked bank account number. Can be displayed as a value |
| maskedcustomeraccountnumber |
If account number type is “ACCOUNT”, the account holder’s account number. If account number type is “CARD” the account holder’s card number (UK-based debt repayment accounts only). (masked) Can be displayed as a value |
| maskediban |
Bank transfer-specific field: Masked international bank account number. Can be displayed as a value |
| maskednationalid |
The customer’s social security number. (masked) Can be displayed as a value |
| maskedpan |
This is the card number printed on the front of the customer’s card. (masked) Can be displayed as a value |
| maskedsocialsecuritynumber |
The customer’s social security number. (masked) Can be displayed as a value |
| md |
3-D Secure-specific field: The unique 3-D Secure reference for this transaction. Can be displayed as a value |
| merchantcategorycode |
Your MCC is a four-digit number assigned to you by your acquirer. It is used to classify the business by the type of products or services it provides. Can be displayed as a value |
| merchantcity |
The merchant city that was used to process the AUTH (if applicable). Can be displayed as a value |
| merchantcountryiso2a |
The merchant country that was used to process the AUTH (if applicable). Can be displayed as a value |
| merchantemail |
The merchant’s email address. Can be displayed as a value |
| merchantname |
The merchant’s name. Can be displayed as a value |
| merchantnumber |
The merchant number. Can be displayed as a value |
| merchantstatecode |
The merchant state code that was used to process the AUTH (if applicable). Can be displayed as a value |
| merchantzipcode |
The merchant zip/post code that was used to process the AUTH (if applicable). Can be displayed as a value |
| nationalid |
The customer’s social security number. Can be displayed as a value |
| operatorname |
The value of this field contains the name of the user that processed the request. Can be displayed as a value |
| orderreference |
Your unique order reference that can be stored on Trust Payments’s system. Can be displayed as a value |
| pan |
This is the card number printed on the front of the customer’s card. Can be displayed as a value |
| parenttransactionreference |
Reference to a previous transaction. Can be displayed as a value |
| pareq |
3-D Secure-specific field: The 3-D authentication request. Can be displayed as a value |
| pares |
3-D Secure-specific field: The 3-D authentication response. Can be displayed as a value |
| paymenttypedescription |
The customer’s payment method, for example “VISA” or “MASTERCARD”. Can be displayed as a value |
| paypaladdressoverride |
Can be displayed as a value |
| paypalemail |
The email address that the customer will use to sign in to PayPal. Can be displayed as a value |
| paypallocaleiso2a |
The language of the PayPal login page. Can be displayed as a value |
| paypalmaxbaseamount |
PayPal-specific field: The expected maximum total amount of the complete order, including shipping cost and tax charges. PayPal uses this value to validate the buyer’s funding source. The amount is in base units, with no decimal points, so £10.50 would be “1050”. Can be displayed as a value |
| paypalmaxmainamount |
PayPal-specific field: The expected maximum total amount of the complete order, including shipping cost and tax charges. PayPal uses this value to validate the buyer’s funding source. The amount is in main units, with decimal points, so £10.50 would be “10.50”. Can be displayed as a value |
| paypalpayerid |
PayPal-specific field: Unique PayPal customer account number. Can be displayed as a value |
| paypalpayerstatus |
PayPal-specific field: The status of the payer with PayPal. Either “verified” or “unverified”. Can be displayed as a value |
| paysafecountryrestriction | Restricts the payment to be processed exclusively from the country specified (in iso2a format).
e.g. “GB” for United Kingdom. Can be displayed as a value |
| paysafeid |
A unique id assigned to the transaction by paysafecard. You can store these ids for future correspondence with paysafecard. Can be displayed as a value |
| paysafekyclevel | Specifies the required KYC level for the “my paysafecard” account holder. There are two levels:
Can be displayed as a value |
| paysafeminage |
The minimum age of the “my paysafecard” account holder, as specified in the ORDER request. Can be displayed as a value |
| rewardid |
The reward id. Can be displayed as a value |
| securitycode |
Security code printed on the card. Can be displayed as a value |
| settleduedate |
The day you would like the transaction to settle. It must be in the format YYYY-MM-DD. Can be displayed as a value |
| settlestatus |
This value relates to the status you would like to set the transaction. Can be displayed as a value |
| sitereference |
Unique reference to your site, received on setup. Can be displayed as a value |
| splitfinalnumber |
Total number of splits permitted. Must be “2” or higher (including the initial authorisation). Can be displayed as a value |
| startdate |
Start date printed on the card. Can be displayed as a value |
| startmonth |
Month of the start date printed on the card. Can be displayed as a value |
| startyear |
Year of the start date printed on the card. Can be displayed as a value |
| stprofile |
Define the profile used to style the Payment Pages. Can be displayed as a value |
| submerchantid |
Value assigned by the payment facilitator when involved in the transaction. Can be displayed as a value |
| subscriptionbegindate |
The date of when the first recurring subscription payment will be processed. Can be displayed as a value |
| subscriptionfinalnumber |
The number of subscriptions to be processed in total over the course of the subscription (including the initial authorisation). Can be displayed as a value |
| subscriptionfrequency | Combined with the subscriptionunit field, this defines how frequently payments are processed.
Can be displayed as a value |
| subscriptionnumber |
The position of the transaction within a series of Subscription payments. Can be displayed as a value |
| subscriptiontype |
The type of Subscription, as required by the acquiring bank. The value can either be “INSTALLMENT” or “RECURRING”. Can be displayed as a value |
| subscriptionunit |
The unit of time between each subscription. This can be either “DAY” or “MONTH”. Can be displayed as a value |
| transactionreference |
Unique reference of the transaction, available after a payment request has been processed. Can be displayed as a value |
| transactionstartedtimestamp |
Timestamp of when the transaction was processed. Can be displayed as a value |
| version |
The version of Payment Pages being used. Can be displayed as a value |
| walletdisplayname |
The name of the wallet used with the transaction. Can be displayed as a value |
| walletid |
Id of the wallet associated with the transaction. Can be displayed as a value |
| walletsource |
The transaction wallet source. Can be displayed as a value |
