Merchant Meta Field for Initialize Payload

Overview

Within the initialize payload you will be presented with an optional field, referred to as merchant_meta. merchant_meta is an optional field and backward compatible with our current JavaScript plugin.

This field allows will allow you to pass Katapult data about the transaction that could be helpful for reporting or tracking.

Suggested Uses

Website: Send over the website URL where the transaction originated from. This is particularly useful if you have unique URL tags for different customers checking out.
Merchant name: Pass through the merchant name that the transaction is being passed from. For example, if you have two websites and are using a single token, you will be able to pass Katapult data on which merchant the origination came from.
Merchant id: If you have a unique id for your stores or website you can pass the information to Katapult here.
Sales type: Pass details about the sales type, you can include if this was a sale sent from an associate or an email.
Promotion type: Include details of any special promotions that were offered to the customer.

Initialize Payload Example

Request

In this example the merchant is sending the merchant name and id, however, any data can be sent within the “merchant_meta”:{ }

{
    "code": "584107",
    "customer": {
        "billing": {
            "first_name": "eMlisan",
            "middle_name": "",
            "last_name": "Onnescean",
            "address": "17474 E Temple Dr",
            "address2": "",
            "city": "Aurora",
            "state": "CO",
            "country": "United States",
            "zip": "80015",
            "phone": "6207102037",
            "email": "[email protected]"
        },
        "shipping": {
            "first_name": "eMlisan",
            "middle_name": "",
            "last_name": "Onnescean",
            "address": "17474 E Temple Dr",
            "address2": "",
            "city": "Aurora",
            "state": "CO",
            "country": "United States",
            "zip": "80015",
            "phone": "6207102037",
            "email": "[email protected]"
        }
    },
    "items": [
        {
            "display_name": "Laptop",
            "sku": "ABC1232",
            "unit_price": 325.0,
            "quantity": 1.0,
            "leasable": true,
            "shipping": {
                "sku": "000GHF00008989",
                "display_name": "Home Delivery Charge",
                "unit_price": "5.0",
                "quantity": "1"
            },
            "warranty": {
                "display_name": "Laptop Warranty",
                "sku": "Warranty SKU",
                "unit_price": 10.0
            }
        },
        {
            "display_name": "Keyboard",
            "sku": "REDDRAGON",
            "unit_price": 20.0,
            "quantity": 1.0,
            "leasable": true
        }
    ],
    "checkout": {
        "customer_id": "AUTOMATION",
        "shipping_amount": 10,
        "discounts": [
            {
                "discount_name": "Laptop Discount",
                "discount_amount": 20
            },
            {
                "discount_name": "Cleaner Discount",
                "discount_amount": 15
            }
        ]
    },
    "merchant_meta": {
        "merchant_name": "chucky",
        "merchant_id": "105"
    },
    "urls": {
        "return": "https://yoursite.com/return",
        "cancel": "https://yoursite.com/cancel"
    },
    "phone": "6207102037",
    "new_address": false
}

Response

Response:
{
    "cart_total": "335.00",
    "delivery": "10.00",
    "delivery_method": "shipping",
    "due_at_checkout": "29.51",
    "due_today": 36.2,
    "extended_service": "0",
    "first_pay_tax": "1.48",
    "full_term_cost": "746.74",
    "initial_payment": "18.52",
    "items": [
        {
            "item_code": "ABC1232",
            "item_name": "Laptop",
            "item_type": "New",
            "quantity": 1,
            "rent": "12.76",
            "merchant_price": "325.00",
            "sales_tax": "1.02",
            "total": "13.78",
            "warranty": {
                "code": "Warranty SKU",
                "monthly_amount": "0.19",
                "monthly_tax": "0.02",
                "name": "Laptop Warranty",
                "price": "10.00"
            }
        },
        {
            "item_code": "REDDRAGON",
            "item_name": "Keyboard",
            "item_type": "New",
            "quantity": 1,
            "rent": "0.79",
            "merchant_price": "20.00",
            "sales_tax": "0.06",
            "total": "0.85"
        },
        {
            "item_code": "000GHF00008989",
            "item_name": "ABC1232 shipping Home Delivery Charge",
            "item_type": "New",
            "quantity": 1,
            "rent": "0.10",
            "merchant_price": "5.00",
            "sales_tax": "0.40",
            "total": "0.50"
        }
    ],
    "leasable_cash_price": "355.00",
    "max_lease_payment": "659.28",
    "monthly_total": "13.31",
    "non_leasable_item_amount": "5.00",
    "non_leasable_tax": "0.40",
    "num_cycles": 52,
    "processing_fee": "0.00",
    "promotion": null,
    "rental_cost": "339.28",
    "shipping": "10.00",
    "shipping_sales_tax": "0.80",
    "shipping_tax": "0.80",
    "tax_due_checkout": "2.68",
    "term": 12,
    "uid": "9c5873625968422fb4d9428d2b033153",
    "warranty_names": [
        "Laptop Warranty"
    ],
    "warranty_payment_total": "0.21"
}