Schema

Overview

When sharing loyalty data such as phone number or email address with Banyan and with the permission of merchant partners, you can receive all receipts associated with that loyalty data. This data looks very similar to an enriched transaction, except it will not include a transaction from the FinX. The way to join the Consumer Match back to your own data set is by using the finx_consumer_token provided.

CMX Top Level

Element	Description	Data Type	Nullable?	Notes
byn_cmx_id	Banyan generated ID when a receipt's consumer token is matched to a finx's consumer token via a common attribute (e.g., phone number, email)	String	no
match_ts	The timestamp of when the match occured	RFC	no	In UTC
finx_consumer_token	Unique ID from the FinX of their user	String	yes
byn_receipt_id		Object	no

cmx.receipt

See retail receipt schema here

See hotel receipt schema here

CMX Example

{
    "byn_cmx_id": "f7c2ae00-1283-5a5e-8fe5-8be1f6760ddf",
    "match_ts": "2025-04-28T21:13:51.247988282Z",
    "finx_consumer_token": "7f4d45-281e-454b-b703-4d5ab5b810",
    "receipt": {
        "byn_receipt_id": "98b04b71-5d24-5cf5-875d-e13d40445aff",
        "hotel": null,
        "merchant_receipt_id": "5877425042503",
        "merchant_mid": "4445100003566",
        "purchase_ts": "2025-04-25T16:18:43Z",
        "order_ts": "",
        "received_ts": "2025-04-28T20:17:35.934Z",
        "merchant": {
            "name": "TESTS"
        },
        "location": {
            "merchant_store_id": "356",
            "name": "TEST",
            "card_acceptor_names": [
                "TEST123"
            ],
            "display_name": "",
            "phone_number": "",
            "address": {
                "address_line_one": "801 16TH ST",
                "address_line_two": "",
                "city": "DENVER",
                "state": "CO",
                "country": "US",
                "postal_code": "80202"
            }
        },
        "order_type": "in_store",
        "fulfillment_type": "in_store",
        "currency": "USD",
        "merchant_total_amount": "33.29",
        "items": [
            {
                "byn_item_id": "da8d7495-af32-5968-9567-29e5d0f8b1a3",
                "merchant_item_id": "",
                "upc": "999999999999",
                "sku": "",
                "image_url": "",
                "brand": "",
                "description": "Excluded Items",
                "amount_paid": "0.1",
                "full_price_per_unit": "0.1",
                "discount_price_per_unit": "0.1",
                "quantity": "1",
                "unit_type": "each",
                "tags": [
                    "excluded:|:excluded item"
                ]
            },
            {
                "byn_item_id": "4ee58caa-fde2-5825-8423-75158baefe9f",
                "merchant_item_id": "",
                "upc": "012000028458",
                "sku": "5032109",
                "image_url": "",
                "brand": "STRBCKS EN",
                "description": "STARBUCKS ENERGY+COFFEE MOCHA15OZ",
                "amount_paid": "4.19",
                "full_price_per_unit": "4.19",
                "discount_price_per_unit": "4.19",
                "quantity": "1",
                "unit_type": "each",
                "tags": [
                    "mdse_cat_name:|:JUICE/RTD/COF",
                    "MDSE_DIV_NAME:|:BEVERAGE",
                    "PRIVATE_LABEL_IND:|:N",
                    "OPS_DEPT_NAME:|:RTD COFFEE",
                    "category_id:|:6636",
                    "category_name:|:RTD COFFEE - SINGLE SERV146001",
                    "item_description:|:STARBUCKS ENERGY+COFFEE MOCHA15OZ",
                    "fsa_item_ind:|:N"
                ]
            },
            {
                "byn_item_id": "3fd2c7ef-a0ba-5321-aa0e-b593980f9480",
                "merchant_item_id": "",
                "upc": "840243144075",
                "sku": "29074448",
                "image_url": "",
                "brand": "BLUE BUFF",
                "description": "BLUE LPF ADLT DOG DRY CHK/BRC 5LB",
                "amount_paid": "20.99",
                "full_price_per_unit": "20.99",
                "discount_price_per_unit": "20.99",
                "quantity": "1",
                "unit_type": "each",
                "tags": [
                    "mdse_cat_name:|:PET",
                    "MDSE_DIV_NAME:|:HHLD&GROCERY",
                    "PRIVATE_LABEL_IND:|:N",
                    "OPS_DEPT_NAME:|:PET NEEDS",
                    "category_id:|:3669",
                    "category_name:|:PET NEEDS - DOG FOOD066012",
                    "item_description:|:BLUE LPF ADLT DOG DRY CHK/BRC 5LB",
                    "fsa_item_ind:|:N"
                ]
            },
            {
                "byn_item_id": "7aa5e46e-b24d-5ae7-9a7e-284ecc44dcbc",
                "merchant_item_id": "",
                "upc": "023100014050",
                "sku": "3705249",
                "image_url": "",
                "brand": "CESAR",
                "description": "CESAR SLCT CHIC AND LIVER 3.5OZ",
                "amount_paid": "2.79",
                "full_price_per_unit": "2.79",
                "discount_price_per_unit": "2.79",
                "quantity": "1",
                "unit_type": "each",
                "tags": [
                    "mdse_cat_name:|:PET",
                    "MDSE_DIV_NAME:|:HHLD&GROCERY",
                    "PRIVATE_LABEL_IND:|:N",
                    "OPS_DEPT_NAME:|:PET NEEDS",
                    "category_id:|:3669",
                    "category_name:|:PET NEEDS - DOG FOOD066012",
                    "item_description:|:CESAR SLCT CHIC AND LIVER 3.5OZ",
                    "fsa_item_ind:|:N"
                ]
            },
            {
                "byn_item_id": "7aa5e46e-b24d-5ae7-9a7e-284ecc44dcbc",
                "merchant_item_id": "",
                "upc": "023100014050",
                "sku": "3705249",
                "image_url": "",
                "brand": "CESAR",
                "description": "CESAR SLCT CHIC AND LIVER 3.5OZ",
                "amount_paid": "2.79",
                "full_price_per_unit": "2.79",
                "discount_price_per_unit": "2.79",
                "quantity": "1",
                "unit_type": "each",
                "tags": [
                    "mdse_cat_name:|:PET",
                    "MDSE_DIV_NAME:|:HHLD&GROCERY",
                    "PRIVATE_LABEL_IND:|:N",
                    "OPS_DEPT_NAME:|:PET NEEDS",
                    "category_id:|:3669",
                    "category_name:|:PET NEEDS - DOG FOOD066012",
                    "item_description:|:CESAR SLCT CHIC AND LIVER 3.5OZ",
                    "fsa_item_ind:|:N"
                ]
            }
        ],
        "image_url": "",
        "barcode_url": "",
        "custom_fields": null,
        "payment": {
            "total_amount": "29.29",
            "payment_type": "CREDIT",
            "scheme": "MC",
            "auth_code": "555555",
            "shipping_amount": null,
            "subtotal_amount": "7.15",
            "tip_amount": "0",
            "tax_amount": "0.14",
            "other_positive_amounts": null,
            "other_negative_amounts": null,
            "cash_back_amount": "0",
            "is_virtual_card": null,
            "card_issuer": "",
            "payment_account_reference": "500155JHQUKVU3PU74DWT39M93XHV"
        }
    }
}