Retail Batch Recommended Field List

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.

Payment Information

NameExampleData TypeDescriptionNotes
Payment TypeDebit, CreditStringCredit card vs Debit card transaction
Card SchemeVisa, Mastercard, AMEXStringThe network the card was issued on
Last 42393StringLast 4 digits on the debit card, credit card
BIN918202StringBank Identification Number associated with the card usedSome BINs will be 8 digits in the near future
Authorization Code482920StringSix digit alphanumeric code passed between banks that signal a transaction is possible
Amount34.50NumericAmount paid for goods/services

Store Information

NameExampleData TypeDescriptionNotes
Merchant NamePickles R USStringBusiness Name
Store ID12093710StringMerchant's Store Identifier
Store NamePickles R US #2StringThe legal / listed name of the store of the purchaseFor brick and mortar transactions only
Store Display NamePickles R USStringThe banner name of the store of the purchaseFor brick and mortar transactions only
Street Address 1100 Main StreetStringNumber and StreetFor brick and mortar transactions only
Street Address 2Fl 2StringFor brick and mortar transactions only
CityHolmdelStringFor brick and mortar transactions only
StateNJStringFor brick and mortar transactions only
Zip/ Postal Code23908StringFor brick and mortar transactions only
Country CodeUSAStringFor brick and mortar transactions only
Phone555-555-5555StringFor brick and mortar transactions only
Websitepicklesrus.comStringFor online purchases, the main domain of the site

Receipt Information

NameExampleData TypeDescriptionNotes
Merchant Transaction ID120394032820StringYour unique ID rendered for each saleThis field will be the same for split tenders whereas your receipt ID will differ
Merchant ID345802717909StringMerchant IDA unique ID for each merchant POS, assigned by merchant bank
Timestamp of Purchase2021-10-01 10:45:55RFC3339The 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 items10NumericThe number of items within a single transaction
Acquirer Reference Number (ARN)1209481040110814StringA unique 16-digit number that tags a credit or debit card transaction when it goes from the merchant’s bank through to the cardholder's bank. Also called a trace ID, this number is often used to determine where a transaction's funds lie at a certain time, and make a transaction traceable in case of an error in bank or merchant accounts.Note: only available with some payment schemes (VISA/Mastercard)
Total Amount100.00NumericAmount paid by the customer
Tax Amount8.00NumericSales tax amount
Subtotal92.00NumericTotal amount less tax amount
Shipping Amount4.99NumericAmount paid for a ship or delivery fulfillment type
Cash Back0.00NumericAmount of cash backRelevant for cash purchases or debit with cash back.
Tip Amount0.00NumericExtra money for services rendered.Should be included in Total Amount.
Receipt Bar Code URLwww.pickles.com/receipts/barcode/2StringThe URL of the barcode for the receipt if available
Order Typein_storeStringWhere the transaction was paid for. Valid examples: in_store, web, app, phoneIf the order was paid for online and picked up in store it is a web transaction.
Fulfillment TypedeliveryStringWhether the transaction was fulfilled by delivery, pickup, ship, or in-store shoppingDelivery vs ship is an option for some stores that have fulfillment within a few hours from the store itself vs from a shipping center
Receipt Image URLwww.pickles.com/receipts/images/29StringThe URL for the image of the receipt if available

Receipt Item Information

NameExampleData TypeDescriptionNote
Item ID123408StringUnique ID for the item sold in the transactionThis 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.
BrandTommy's PicklesStringBrand of the item
DescriptionGallon Half Sour PicklesString
SKU1234325StringStore specific ID of item
UPC4563226115636StringUniversal product codePlease tell Banyan whether the UPC you have provided includes a check number already
Full Price Per Unit15.00NumericThe regular price for the item specified in the item id
Discount Price Per Unit13.99NumericThe amount paid for the itemThis might differ from Item List Price if the item is on sale
CategoryFoodStringIf you have an internal categorization of the item
Unit TypeEachStringThe unit the item is sold inOther examples: lbs, oz
Quantity2NumericNumber of the same item purchasedIf it is a returned item, this number should be negative

Customer Information

NameExampleData TypeDescriptionNote
Custom field for loyalty group 110290StringA segment of customers you later want to filter on/see as a dimension in your reports
Custom field for loyalty group 223424StringA second segment of customers you later want to filter on/see as a dimension in your reports

🚧

These are logical groupings of fields and should have no bearing on how you break up or flatten the data you send to Banyan