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 | |
| 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 | |
| Name | Example | Data Type | Description | Notes |
|---|
| Merchant Name | Umbrella Hotels | String | Business Name | |
| Location ID | 12093710 | String | Location Identifier | |
| Hotel Name | Boutique Hotel -NJ | String | The legal / listed name of the store of the purchase | |
| Store Display Name | Boutique Hotel | String | The banner name of the store of the purchase | |
| Card Acceptor Name | Hotel 90829-1 | 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 | |
| Street Address 2 | Fl 2 | String | | |
| City | Holmdel | String | City of hotel | |
| State | NJ | String | State of hotel | |
| Zip/ Postal Code | 23908 | String | Postal code of the hotel | Needs to be 5 characters in length |
| Country Code | USA | String | Country code of the hotel | |
| Phone | 555-555-5555 | String | Phone number of the hotel | |
| Name | Example | Data Type | Description | Notes |
|---|
| Itinerary Number | 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 | Also known as MID, it’s a 15-digit distinctive code assigned by merchant bank to identifies a merchant account to their acquirer |
| Guest Name(s) | John Smith, Olivia Smith | Array | Names of hotel guests | This data will be either encrypted before it gets to Banyan or on ingestion and will stay encrypted to the consumer of the data |
| Purchase Timestamp | 2021-11-01 10:45:55 | RFC3339 | The time that payment is used to charge the total amount of the stay | This can be different than when the charge is posted to the financial institution. Please let Banyan know if this is the case |
| Reservation Timestamp | 2021-10-01 10:45:55 | RFC3339 | The time at which the reservation occurred (UTC if possible) | |
| Authorization Code | 102481 | String | Six digit alphanumeric code passed between banks that signal a transaction is possible | |
| Total Charges | 1000.00 | Numeric | Amount paid by the customer | |
| Total Credits | 50.00 | Numeric | Cashing in any points or other refunds associated with the stay | |
| Receipt Bar Code URL | www.pickles.com/receipts/barcode/2 | String | The URL of the barcode for the receipt if available | |
| 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. | |
📘
As rates change per day, Banyan has "Per Night Date" as a top level object that houses an array of fees/costs within each date value
| Name | Example | Data Type | Description | Note |
|---|
| Per Night Date | 2022-10-01 | Date | Date of the charge | Illustrative to show that each field within room information is by day. Can be represented in local timezone. |
| Room Rate | 239 | Numeric | Nightly rate for the room | |
| Room Description | King with Balcony and Ocean View | String | Long name for the room | |
| Room Type | King Suite | String | Type of bed | |
| Name | Example | Data Type | Description | Note |
|---|
| Per Night Date | 2022-10-01 | Date | Date of the charge | Illustrative to show that each field within tax information is by day. Can be represented in local timezone. |
| Tourism Tax | 20.00 | Numeric | Any revenue-generating measure targeted at tourists | |
| State Occupancy | 14.00 | Numeric | Occupancy taxes typically apply to short-term lodging rentals, and go by many names, such as hotel tax, hotel/motel tax, lodging tax and transient room tax | |
| City Occupancy | 7.00 | Numeric | Occupancy taxes typically apply to short-term lodging rentals, and go by many names, such as hotel tax, hotel/motel tax, lodging tax and transient room tax | |
| Other Tax | | Numeric | | |
| Name | Example | Data Type | Description | Note |
|---|
| Per Night Date | 2022-10-01 | Date | Date of the charge | Illustrative to show that each field within dining information is by day. Can be represented in local timezone. |
| Room Service Food Daily Amount | 14.99 | Numeric | Amount of food ordered in the room | |
| Room Service Food Description | Caesar Salad | Array | Description of food ordered in the room | |
| Room Service Tip | 2.99 | Numeric | Amount of tip on the room service | |
| Mini Bar Charge Daily Amount | 15.00 | Numeric | Amount of mini bar charges | |
| Mini Bar Charge Description | 15.00 | String | Description of mini bar items | |
| Name | Example | Data Type | Description | Note |
|---|
| Per Night Date | 2022-10-01 | Date | Date of the charge | Illustrative to show that each field within dining information is by day. Can be represented in local timezone. |
| Resort Fee | 4.99 | Numeric | A daily resort fee is an additional fee charged by the property for guests to enjoy their amenities. | |
| Incidental Cost | 8.99 | Numeric | Gratuities and other minor fees or costs incurred | |
| Parking Fee | 25 | Numeric | Daily amount for parking | |
| Business Center Fee | 9.99 | Numeric | Daily amount for using the business center | |
| Laundry Fee | 8.99 | Numeric | Charge for using laundry service | |
| Upgrade Fee | 29.99 | Numeric | Upgrading to a higher priced room | |
| Cancellation Fee | 25 | Numeric | Fee for cancelling outside of the refund window | |
| No Show Fee | 50 | Numeric | Not showing up for the reservation | |
| Other Fee | 2.99 | Numeric | | Use for any fee particular to your fee list that isn't already covered by Banyan's schema |
| 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
