Payment Widget parameters
transactionType String Required
Used to indicate if the transaction is a sale or an authorisation that will be captured later.
Enum: “sale”, “authorize”
language String OptionalEnum: “EN”
showTruevo Boolean OptionalWhether to display the trusted Truevo logo and footer text inside the widget content.
iframeStyles Object Optionaliframe styles
theme String OptionalEnum: “classic”, “minimalist”, “expanded“, “compact“, “contained“. The CSS theme for the widget content. By default “classic“ theme is set as default theme.
style String OptionalCustom CSS stylesheet to apply to the widget content. Learn more about CSS styling capabilities here.
isDarkTheme Boolean OptionalUsed to enable dark mode of current selected theme.
isInline Boolean OptionalWhether to display the Payment widget for inline flow or redirect flow.
merchantReference String RequiredA reference provided by you for the transaction, commonly used for reconciliation. It is recommended that the identifier is unique to the transaction.
paymentReference String RequiredA reference provided as a description for the transaction.
amount Object RequiredTransaction amount.
totalAmount Number RequiredThe total amount requested for the transaction. If a breakdown is specified, this would represent the sum of all detailed amounts.
currencyAlphaCode String RequiredThe currency alpha code of the transaction, specified with the three-character ISO 4217 code.
details Object RequiredAmount details.
paymentAmount Number RequiredThe net transaction amount prior to specifying additional amounts, such as gratuity.
gratuityAmount Number OptionalThe additional amount the payer has chosen to provide as a tip or gratuity.
merchantShopperReference String Required(if tokenization object is specified)The unique reference assigned to a cardholder in order to group tokenized card details under a customer. Ideally, this should be the cardholder username within a ecommerce system.
tokenRegistrationProcess String Required(if tokenization object is specified)Used to indicate the process to be taken for storing cards. If Optional is used, the storing of card details will be done based on the decision of the cardholder at the time of inputting card details for the transaction.
Enum: “Always”, “Optional”, “None”
descriptor String OptionalMay be used to populate the merchant name descriptor presented in the cardholder’s statement. Contact Truevo for details.
redirectUrl String OptionalThe URL a cardholder must be redirected to after completing a 3DS challenge in a browser-based flow.
mid String RequiredThe unique identifier issued to you by Truevo.
tid String RequiredThe identity of the terminal utilised in the transaction. This will also be supplied to you by Truevo.
firstName String OptionalThe first name of the customer.
lastName String OptionalThe last/family name of the customer.
birthDate String OptionalThe date of birth of the customer in this format: YYYY-MM-DD
contact Object OptionalCustomer’s contact details.
email String Optional Required (if customer object is specified)The email address of the customer.
mobile String OptionalThe mobile number of the customer.
phone String OptionalThe home phone number of the customer.
workPhone String OptionalThe work phone number of the customer.
url String OptionalThe website URL of the customer.
ip String OptionalThe IP address of the customer.
street1 String OptionalLine 1 of the street address.
street2 String OptionalLine 2 of the street address.
city String OptionalThe name of the city/town.
state String OptionalThe name of the state/county.
postCodeZip String OptionalThe postal/zip code.
countryAlphaCode String OptionalThe alpha 2 code of the country, relates to country name.
key String (no spaces) OptionalAn identifier for the provided value.
value String (no spaces) OptionalThe content of the provided value.
signature String Optional
The generated digital signature that ensures no tampering has occurred with a request sent to us. Read how to create a digital signature here.