We will accept data that is flattened (joined together) or as separate tables with foreign keys. We understand that the nomenclature used here may not match what is in your data warehouse - that is okay! We will use part of the onboarding process to confirm our understanding of the data you send before the programmatic setup begins.
| Name | Example | Data Type | Description | Notes |
|---|
| Payment Type | Debit, Credit | String | Credit card vs Debit card transaction | |
| Card Scheme | Visa, Mastercard, AMEX | String | The network the card was issued on | |
| Card Last 4 | 2393 | String | Last 4 digits on the debit card, credit card | |
| BIN | 918202 | String | Bank Identification Number associated with the card used | Some BINs will be 8 digits in the near future |
| Authorization Code | 482920 | String | Six digit alphanumeric code passed between banks that signal a transaction is possible | |
| Amount | 34.50 | Numeric | Amount paid for goods/services | |
| Is Virtual | TRUE | Boolean | Whether the card sent is a virtual card/wallet or a standard credit card | Null if not a credit/debit transaction |
| Payment Account Reference | 93809820980918090983734655718 | String | Payment Account Reference (PAR) is generated by the networks as a stable ID across tokens and PANs | |
| Name | Example | Data Type | Description | Notes |
|---|
| Merchant Name | Pickles R US | String | Business Name | |
| Store ID | 12093710 | String | Merchant's Store Identifier | |
| Location Name | Pickles R US #2 | String | The legal / listed name of the store of the purchase | For brick and mortar transactions only |
| Location Display Name | Pickles R US | String | The banner name of the store of the purchase | For brick and mortar transactions only |
| Card Acceptor Name | BAG STORE 124a-ddf8 | String | The identification value used by payment processors to identify the location of the card acceptor terminal | |
| Street Address 1 | 100 Main Street | String | Number and Street | For brick and mortar transactions only |
| Street Address 2 | Fl 2 | String | | For brick and mortar transactions only |
| City | Holmdel | String | | For brick and mortar transactions only |
| State | NJ | String | | For brick and mortar transactions only |
| Zip/ Postal Code | 23908 | String | | Needs to be 5 characters. For brick and mortar transactions only |
| Country Code | USA | String | | For brick and mortar transactions only |
| Phone | 555-555-5555 | String | | For brick and mortar transactions only |
| Website | picklesrus.com | String | For online purchases, the main domain of the site | |
| Name | Example | Data Type | Description | Notes |
|---|
| Merchant Transaction ID | 120394032820 | String | Your unique ID rendered for each sale | This field will be the same for split tenders whereas your receipt ID will differ |
| Merchant ID | 345802717909123 | String | Merchant ID | Also known as MID, it’s a 15-digit distinctive code assigned by merchant bank to identifies a merchant account to their acquirer |
| Timestamp of Purchase | 2021-10-01 10:45:55 | RFC3339 | The time at which purchase occurred (UTC if possible) | This can be different than when the charge is posted to the financial institution. Please let Banyan know if this is the case |
| Number of items | 10 | Numeric | The number of items within a single transaction | |
| Total Amount | 100.00 | Numeric | Amount paid by the customer | |
| Tax Amount | 8.00 | Numeric | Sales tax amount | |
| Subtotal | 92.00 | Numeric | Total amount less tax amount less shipping less tip | |
| Shipping Amount | 4.99 | Numeric | Amount paid for a ship or delivery fulfillment type | |
| Cash Back | 0.00 | Numeric | Amount of cash back | Relevant for cash purchases or debit with cash back. |
| Tip Amount | 0.00 | Numeric | Extra money for services rendered. | Should be included in Total Amount. |
| Receipt Bar Code URL | www.pickles.com/receipts/barcode/2 | String | The URL of the barcode for the receipt if available | |
| Order Type | in_store | String | Where the transaction was paid for. Valid examples: in_store, web, app, phone | If the order was paid for online and picked up in store it is a web transaction. |
| Fulfillment Type | delivery | String | Whether the transaction was fulfilled by delivery, pickup, or a ship option | If the order was an in_store purchase, the fulfillment should also be noted as in_store. |
| Receipt Image URL | www.pickles.com/receipts/images/29 | String | The URL for the image of the receipt if available | |
| Currency | USD | String | Alphabetic currency code associated with the value in ISO 4217 format. | |
| Name | Example | Data Type | Description | Note |
|---|
| Item ID | 123408 | String | Unique ID for the item sold in the transaction | This ID is a sequencing ID on the receipt. It could be a unique ID from the basket detail table or a counter on each receipt. Used for QA purposes. |
| Brand | Tommy's Pickles | String | Brand of the item | |
| Description | Gallon Half Sour Pickles | String | | |
| SKU | 1234325 | String | Store specific ID of item | |
| UPC | 4563226115636 | String | Universal product code | Please tell Banyan whether the UPC you have provided includes a check number already |
| Full Price Per Unit | 15.00 | Numeric | The regular price for the item specified in the item id | |
| Discount Price Per Unit | 13.99 | Numeric | The amount paid for the item | This might differ from Item List Price if the item is on sale |
| Category | Food | String | | If you have an internal categorization of the item |
| Unit Type | Each | String | The unit the item is sold in | Other examples: lbs, oz |
| Quantity | 2 | Numeric | Number of the same item purchased | If it is a returned item, this number should be negative |
| Name | Example | Data Type | Description | Note |
|---|
| Custom field for loyalty group 1 | 10290 | String | A segment of customers you later want to filter on/see as a dimension in your reports | |
| Custom field for loyalty group 2 | 23424 | String | A second segment of customers you later want to filter on/see as a dimension in your reports | |
| Phone Number | 555555555 | String | The phone number of the customer | This is relevant only if there is a loyalty program. Currently only accepting US phone numbers |
| Email | [email protected] | String | The email address of the customer | This is relevant only if there is a loyalty program. |
🚧
These are logical groupings of fields and should have no bearing on how you break up or flatten the data you send to Banyan
