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.

🚧

Required vs Preferred Fields

All red items in the list are required for match integrity. If you are unable to send a required field Banyan will work with you to find a proxy.

Tender Information

Name

Example

Description

Note

Payment Type

Debit, Credit

Credit card vs Debit card transaction

Card Scheme

Visa, Mastercard, AMEX

The network the card was issued on

Last 4

2393

Last 4 digits on the debit card, credit card

Amount

34.50

Amount paid for goods/services

Currency Code

USD, CAD

3 lettered code of the currency the amount is in

Store Information

Name

Example

Description

Notes

Merchant Name

Pickles R US

Business Name

Store ID

12093710

Merchant's Store Identifier

Store Name

Pickles R US #2

The legal / listed name of the store of the purchase

For brick and mortar transactions only

Store Display Name

Pickles R US Holmdel NJ

The banner name of the store of the purchase

For brick and mortar transactions only

Street Address 1

100 Main Street

For brick and mortar transactions only

Streed Address 2

Fl 2

For brick and mortar transactions only

City

Holmdel

For brick and mortar transactions only

State

NJ

For brick and mortar transactions only

Zip/ Postal Code

23908

For brick and mortar transactions only

Country Code

1

For brick and mortar transactions only

Phone

555-555-5555

For brick and mortar transactions only

Purchase Type

Instore/Web

The channel of the purchase

Website

picklesrus.com

For online purchases, the main domain of the site

Transaction Information

Name

Example

Description

Notes

Merchant Transaction ID

120394032820

Your unique ID rendered for each sale

This field may include store ID if your transaction IDs are reused across stores

Timestamp of Purchase

2021-10-01 10:45:55

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

The number of items within a single transaction

Authorization Code

102481

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

Acquirer Reference Number (ARN)

1209481040110814

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

Amount paid by the customer

Tax Amount

8.00

Sales tax amount

Subtotal

92.00

Total amount less tax amount

Change Due

0.00

Amount of cash back

Relevant for cash purchases or debit with cash back.

Tip Amount

0.00

Extra money for services rendered.

Should be included in Total Amount.

Item Information

Name

Example

Description

Note

Item ID

123408

Unique ID for the item sold in the transaction

May be the same as the SKU

Brand

Tommy's Pickles

Brand of the item

Description

Gallon Half Sour Pickles

SKU

1234325

Store specific ID of item

May be the same as Item ID

UPC

4563226115636

Universal product code

Item List Price

15.00

The regular price for the item specified in the item id

Tendered Price

13.99

The amount paid for the item

This might differ from Item List Price if the item is on sale

Category

Food

If you have an internal categorization of the item

Quantity

2

Number of the same item purchased

Customer Information

Name

Example

Description

Note

Custom field for loyalty group 1

10290

A segment of customers you later want to filter on/see as a dimension in your reports

Custom field for loyalty group 2

23424

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?