Data integration for Pay+
Rokt Pay+ partners must integrate the following attributes via SDK, server-to-server, or equivalent methods, across the payment / bag and confirmation pages, to unlock the full scale of advertisers and campaign types. While attributes marked “If Avail.” are not required at launch, they should be prioritized for integration to maximize campaign eligibility and targeting, and ultimately revenue.
Core Attributes
If you need to change any of these attributes, please work with your account manager.
| Description | Attribute Name | Payments Page | Confirmation Page | Format | Payload Example |
|---|---|---|---|---|---|
| If Avail. | Required | String | john.smith@rokt.com | ||
| First Name | firstname | If Avail. | Required | String | John |
| Last Name | lastname | If Avail. | Required | String | Smith |
| Billing Zip | billingzipcode | If Avail. | Required | String | 10014 or 10014-1234 |
| Amount | amount | Required | Required | Decimal | 300.5 See Amount |
| The billing country of the user | country | Required | Required | ISO Alpha-2 Country Code | Examples |
| Currency | currency | Required | Required | String | USD See Currency |
| Language | language | Required | Required | String | EN |
| Payment Type | paymenttype | N/A | Required | Comma-separated strings (platform, card brand, payment network). Pipes (|) separate split payments | Gift card | Chase, Visa See Payment Type |
| Cart Items | cartitems | Required | Required | Any complex data type supported (array, object, string) | See Cart item data |
| CCBIN | ccbin | N/A | Required | First 6-8 digits of card BIN | 123456 or 12345678 |
| Confirmation Reference | confirmationref | N/A | Required | String | XYZ123 See Confirmation Ref |
| Mobile | mobile | If Avail. | Required | String | 7325558585 |
| Age | age | If Avail. | Required | Integer | 29 |
| Gender | gender | If Avail. | Required | String | m |
| Billing Address 1 | billingaddress1 | If Avail. | Required | Allowed special characters: -'´`",.:;#&/()+@ °ºᵃª_ \ | 123 Main St |
| Billing Address 2 | billingaddress2 | If Avail. | Required | Allowed special characters: -'´`",.:;#&/()+@ °ºᵃª_ \ | Apt 32 |
| The customer who created the order | clientcustomerid | If Avail. | If Avail. | ID | abcdefgh1234567 |
| The corresponding cart ID for the order | cartid | If Avail. | If Avail. | ID | 7654321hgfedcba |
| The total of the order without taxes or shipping applied. | subtotal | If Avail. | If Avail. | Decimal | 200.25 |
| The total amount of tax on the order. | totaltax | If Avail. | If Avail. | Decimal | 20.5 |
| The total amount of shipping fees on the order. | totalshipping | If Avail. | If Avail. | Decimal | 5.00 |
| The average profit margin on a sale. | margin | If Avail. | If Avail. | Decimal | 2.00 |
| The billing user's city or suburb depending on the region. | billingcity | If Avail. | If Avail. | String | San Francisco |
| The state of the payment type. | billingstate | If Avail. | If Avail. | String | California or CA |
| The first line of where the order is to be shipped. | shippingaddress1 | If Avail. | If Avail. | Allowed special characters: -'´`",.:;#&/()+@ °ºᵃª_ \ | 123 Main St |
| The second line of where the order is to be shipped. | shippingaddress2 | If Avail. | If Avail. | Allowed special characters: -'´`",.:;#&/()+@ °ºᵃª_ \ | Apt 32 |
| The city where the order is to be shipped. | shippingcity | If Avail. | If Avail. | String | San Francisco |
| The state where the order is to be shipped. | shippingstate | If Avail. | If Avail. | String | California or CA |
| The zip or postal code where the order is to be shipped. | shippingzipcode | If Avail. | If Avail. | Zipcode | 10014 or 10014-1234 |
| The country where the order is to be shipped. | shippingcountry | If Avail. | If Avail. | ISO Alpha-2 Country Code | Examples |
| Description of the type of customer (e.g. guest or member) | customertype | If Avail. | If Avail. | String | guest |
| Defines whether the customer is a member of your loyalty program. | isloyalty | If Avail. | If Avail. | Boolean | true |
| Description of the loyalty tier for customers who are members of a program. | loyaltytier | If Avail. | If Avail. | String | Gold |
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. |
Further information
Payment Type
Partners should provide all payment-related information in the paymentType field, formatted as:
- Attribute values should be comma-separated (,) (e.g. platform, card brand, payment network).
- Pipes (|) separate split payments (e.g. gift card + credit card).
- Split payments will be captured as separate attributes (i.e. paymentType, paymentType2). This maintains compatibility with existing downstream systems. At launch, we will capture up to two payment methods per transaction. Clients sending more than two methods should put the two methods that accounted for the largest portion of the transaction balance first.
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 |
Currency
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.