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

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

Last 4

2393

Numeric

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

Amount

34.50

Numeric

Amount paid for goods/services

Store Information

Name

Example

Data Type

Description

Notes

Merchant Name

Pickles R US

String

Business Name

Store ID

12093710

String

Merchant's Store Identifier

Store Name

Pickles R US #2

String

The legal / listed name of the store of the purchase

For brick and mortar transactions only

Store Display Name

Pickles R US

String

The banner name of the store of the purchase

For brick and mortar transactions only

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

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

Receipt Information

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

345802717909

String

Merchant ID

A unique ID for each merchant POS, assigned by merchant bank

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

Authorization Code

102481

String

Six digit alphanumeric code passed between banks that signal a transaction is possible

Acquirer Reference Number (ARN)

1209481040110814

String

A 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 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

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 be noted as pickup

Receipt Image URL

www.pickles.com/receipts/images/29

String

The URL for the image of the receipt if available

Receipt Item Information

Name

Example

Data Type

Description

Note

Item ID

123408

String

Unique ID for the item sold in the transaction

May be the same as the SKU

Brand

Tommy's Pickles

String

Brand of the item

Description

Gallon Half Sour Pickles

String

SKU

1234325

String

Store specific ID of item

May be the same as Item ID

UPC

4563226115636

String

Universal product code

Please tell Banyan whether the UPC you have provided includes a check number already

Item List Price

15.00

Numeric

The regular price for the item specified in the item id

Tendered Price

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

Quantity

2

Numeric

Number of the same item purchased

If it is a returned item, this number should be negative

Customer Information

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

🚧

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


Did this page help you?