Last updated Nov 7, 2024

Data integration

It is important that you integrate the appropriate data elements to enable Rokt to load each of the approved payment provider sign up or application flows. Your account manager will work with you to gather the required information and will then provide you with a custom snippet based on your specific needs.

Core attributes - Payments page

IMPORTANT

If you need to change any of these attributes, please work with your account manager.

This table shows the core attributes required to select and display the Rokt placement. These attributes should be integrated when available on the confirmation page.

Description	Attribute name	Format	Payload example
Amount	amount	decimal	300.5
Email (if present)	email	string	john.smith@rokt.com
First name	firstname	string	John
Last name	lastname	string	Smith
Billing Zip	billingzipcode	string	10014 OR 10014-1234
Country	country	ISO Alpha-2 Country Code	Examples
Language	language	string	EN
Currency	currency	string	USD
Cart Data	cartItems	any complex data type supported (array, object, string)	See Cart item data

Core attributes - Confirmation page

It is critically important to add the following attributes to the confirmation page integration, if they are not available already, to enhance optimization and drive more relevancy for the payments page placements:

Description	Attribute name	Format	Payload example
Email	email	string	john.smith@rokt.com
First name	firstname	string	John
Last name	lastname	string	Smith
Confirmation reference	confirmationref	string	XYZ123
Billing Zip	billingzipcode	string	10014 OR 10014-1234
Amount	amount	decimal	300.5
Payment type	paymenttype	string	Credit Card, PayPal, Apple Pay
Credit card BIN	ccbin	string	372888
Mobile	mobile	string	7325558585
Country	country	ISO Alpha-2 Country Code	Examples
Age	age	integer	28
Gender	gender	string	m
Language	language	string	EN
Billing Address	billingaddress1	string	175 Varick St
Billing Address Line 2	billingaddress2	string	Floor 10
Currency	currency	string	USD
Cart Data	cartItems	any complex data type supported (array, object, string)	See Cart item data

Cart item data

cartItems can be provided in any format, arrays, objects, or strings, and should contain the following properties for each product in the cart.

Attribute name	Type	Description
majorCat	string	The major category of the product, also known as the first level of the product taxonomy.
majorCatID	string	The major product category ID.
minorCat1	string	The minor category of the product, also known as the second level of the product taxonomy.
minorCatID	string	The minor category product ID.
minorCat2	string	The third level of the product taxonomy.
minorCat3	string	The fourth level of the product taxonomy.
minorCat4	string	The fifth level of the product taxonomy.
sku	string	The product Stock keeping unit or SKU.
productName	string	The product name of the product.

Optimization and analytics attributes

Rokt asks you to populate data attributes about the transaction to help us better personalize offers the customer sees. Including these data elements in your integration allows for enhanced targeting and optimization capabilities leading to increased engagement, more revenue, and a better customer experience.

Many of the attributes listed below are also important for Rokt to provide analytics and reporting related to your ecommerce transaction, for example, reporting on transaction revenue and cart conversion rate.

Attribute name	Type	Accepted values (if available)	Description
customerid	string		The customer who created the order.
cartid	id		The corresponding ID of the cart that became this order.
subtotal	number		The total of the order without taxes or shipping applied.
totalTax	number		The total amount of tax on the order.
totalShipping	number		The total amount of shipping fees on the order.
margin	amount		The average profit margin on a sale.
currency	currency code		The currency that the order is in.
shippingAddress1	address		The first line of where the order is to be shipped.
shippingAddress2	address		The second line of where the order is to be shipped.
shippingCity	string		The city where the order is to be shipped.
shippingState	string		The state where the order is to be shipped.
shippingZipcode	zipcode	Validation according to Universal Postal Union addressing systems.	The zip or postal code where the order is to be shipped.
shippingCountry	string		The country where the order is to be shipped.
shippingCompanyName	string		The name of the company placing the order (if applicable).
paymentMethod	string	- Digital payment - Card payment - Bank transfer - Physical payment	The payment method specifies the payment procedure by which payments are made.
paymentSubMethod	string	For digital payment: - Buy Now Pay Later - Digital Wallets For card payment: - Credit Card - Debit Card - Prepaid Card. For bank transfer: - Bank Transfer - Direct Debit For physical payment: - Cash - Check	This represents the specific mode of payment chosen by the customer. Please note that the payment submethods vary depending on the payment method.
paymentBrand	string	Common examples include: - Paypal - Venmo - Apple Pay - Google Pay - Amazon Pay - Afterpay - AMEX.	The brand associated with the payment.
paymentIssuer	string	Common examples include: - Barclays - Citibank - Bank of America - AMEX - JPMorgan Chase - Discover - Wells Fargo - Capital One - HSBC	Payment issuers are banks or financial institutions that provide payment cards to individuals or businesses.
paymentNetwork	string	Common examples include: - Mastercard - Visa - Discover - American Express - JCB - Interac - UnionPay	Payment networks provide the infrastructure and rules for securely transmitting payment information between the merchant, the customer's bank, and the payment processor.
billingAddress1	address	Allowed special characters: -'´`",.:;#&/()+@ °ºᵃª_ \	The first line of the address on the payment type.
billingAddress2	address	Allowed special characters: -'´`",.:;#&/()+@ °ºᵃª_ \	The second line of the address on the payment type.
billingCity	string		The billing user's city or suburb depending on the region.
billingState	string		The state on the payment type.
billingZipcode	zipcode	Validation according to Universal Postal Union addressing systems.	The zip or postal code on the billing type.
billingCountry	string		The coountry on the billing type.
title	string	- Mr - Mrs - Miss - Mx	Salutation or title of the customer.
firstName	string		The customer's first name.
lastName	string		The customer's last name.
customerType	string		Description of the type of customer.
hasAccount	boolean	- True - False	Describes whether the customer is logged in or not.
isReturning	boolean	- True - False	Describes if the customer has previously been seen on the site.
lastVisited	datetime	A valid date and time.	The date and time when the customer was last active on the site.
isLoyalty	boolean	- True - False	Defines whether the customer is a member of your loyalty program.
loyaltyTier	string		Description of the loyalty tier for customers who are members of a loyalty program.
age	integer		Your customer's age.
gender	string		Your customer's identified gender.
dob	date		Your customer's date of birth.

Further information

Amount

The value provided to the Rokt Placement through the amount attribute reflects the full price displayed to the customer on the page. On a checkout or payment page, the amount should be the subtotal.

Accepted values
Any integer, or double with at most 2 significant figures after the decimal separator.

Country and language

The value provided under country should reflect the region of your store and the value under language the content of your webpage. The Rokt placement will only show offers in the same language as the webpage where they appear, and products relevant to the customers shopping location.

Country	Language	Store locale
United States	English	en_US

IMPORTANT

No other countries or languages are supported for Payments Marketplace at this time.

Curency

When provided, this attribute formats the currency for a given locale. Providing a value ensures we display prices in the correct currency for the customer’s locale.

Confirmation reference

Providing the confirmation reference ID allows us to count distinct transactions for reporting purposes.