Advertiser Data Onboarding Guide
If a merchant you would like to work with on category/item level card linked offers (CLO) is not already part of the Banyan network, we will work with them to ensure all necessary data elements are available. Just as with our Banyan Enrich product, we offer both an API for data onboarding as well as a file transfer option.
For CLO, we have more strict guidelines for payment identifiers that ensures we never miss a fulfilled reward, but otherwise it is very similar to our onboarding guidelines for Enrich. Below are the merchant file types and fields within that are necessary for a successful CLO campaign.
Transaction File
The transaction file has elements that apply to the overall transaction
| Field Name | Description | Example |
|---|---|---|
| Merchant Transaction ID | Your unique ID rendered for each sale | 120394032820 |
| Timestamp of Purchase | The time at which purchase occurred (UTC if possible) | 2021-10-01 10:45:55 |
| Total Amount | Amount paid by the customer | 100.00 |
| Tax Amount | Sales tax amount | 10 |
| Shipping Amount | Shipping amount paid by the customer | 10 |
| Subtotal | Total amount less tax and shipping | 80 |
| Order Type | Where the transaction was paid for. Valid examples: in_store, web, app, phone | in_store |
| Fulfillment Type | Whether the transaction was fulfilled by delivery, pickup, or a ship option | ship |
| Currency | Alphabetic currency code associated with the value in ISO 4217 format. | USD |
Tender
The tender file has all payment details and ties back to the transaction file through a transaction id
| Field Name | Description | Example |
|---|---|---|
| Card Last 4 | Last 4 digits on the debit card, credit card | 2222 |
| Card Scheme | The network the card was issued on | Mastercard |
| Authorization Code | Six digit alphanumeric code passed between banks that signal a transaction is possible | 389209 |
| Amount | Total amount charged | 100 |
Item File
The item file has the list of items related to each transaction which ties back to the transaction file through a transaction id
| Field Name | Description | Example |
|---|---|---|
| Item ID/SKU | Unique ID for the item sold in the transaction | 10410948031 |
| Description | Merchant description of the item | Cloudy Sky Pencil |
| UPC | Universal product code | 3091380910830980 |
| Full Price Per Unit | The regular price for the item specified in the item id | 1.99 |
| Discount Price Per Unit | The amount paid for the item | 1.79 |
| Unit Type | The unit the item is sold in | Each |
| Quantity | Number of the same item purchased | 5 |
Product Taxonomy
The product taxonomy has granular detail about each item in the item file. This will be what is used to define what categories/departments/brands qualify or do not qualify for the offer. The below is not an exhaustive list, we will take whatever is in your taxonomy. Providing and using IDs is always preferred over names in the case that names are updated. This file should tie to the item file using the SKU field.
| Field Name | Description | Example |
|---|---|---|
| Category ID | ID for merchant defined category | 10 |
| Category Name | Name for merchant defined category | Beauty |
| Department ID | ID for department within merchant store | 4 |
| Department Name | Name for department within merchant store | Home |
| Private Label Flag | Whether the item is produced by the merchant | True |
| Brand | The brand of the item | Cloudy Sky |
| SKU | The merchant defined ID | 19081038 |
| UPC | Universal product code | 3803091803180 |
Updated 11 months ago