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.
For official schemas please see the API Reference pages of our documentation.
| Name | Example | Data Type | Description | Notes |
|---|
| Transaction ID | 21980107303829034 | String | | |
| Purchase Timestamp | 2021-11-01 01:34 | RFC3339 if CSV, Epoch Millis if Avro | When end customer completed their transaction | This can differ from when the transaction is received from the Banyan client |
| Description | Bob's Convenience Boston MA | String | | |
| Authorization Timestamp | 2021-10-31 22:25 | RFC3339 if CSV, Epoch Millis if Avro | When authorization was requested to the issuer | |
| Custom Fields | Customer Group A | Array of Strings | A free field to add attributes to a transaction | |
| Order Type | Web | String | Where the transaction was paid for. Valid examples: in_store, web, app, phone | |
| Name | Example | Data Type | Description | Note |
|---|
| 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 | Numeric | Last 4 digits on the debit card, credit card | |
| Authorization Code | 102481 | String | Six digit alphanumeric code passed between banks that signal a transaction is possible | |
| BIN | 392019 | String | Bank Identification Number associated with the card used | BINs will soon be 8 digits in length |
| 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 / Discover) |
| Total Amount | 34.50 | Numeric | Amount paid for goods/services | |
| Currency | USD | String | Alphabetic currency code associated with the value in ISO 4217 format. | |
| Name | Example | Data Type | Description | Notes |
|---|
| Raw Merchant Name | Bob's Convenience Store at Shell Gas 143 | String | | |
| Merchant Name | Shell | String | Banner name of the merchant | |
| Address | 123 Main Street | String | | If ecommerce, should be null |
| City | Boston | String | | If ecommerce, should be null |
| State | MA | String | | If ecommerce, should be null |
| Zip Code | 02108 | String | | If ecommerce, should be null |
| Merchant Category Code (MCC) | 9301 | String | Acquirer assigned category code | |
| Merchant Category Code Name | Convenience | String | MCC code name | |
| Store ID | 143 | String | ID for the specific location under the merchant | |
| Merchant Identification Number (MID) | 132480128410647 | String | A merchant identification number (MID) is a distinctive, numerical code that identifies a merchant to their acquirer. | |
| Name | Example | Data Type | Description | Notes |
|---|
| Customer Token | 50198WEN370032 | String | FinX specified consumer token to be used for querying Banyan API Consumer History product | |
| Customer Account Token | 1029470127401410 | String | FinX specified account ID | Available if more than one user can share an account |
