Examples

1. Basic example - Only mandatory request data fields

curl --location --request POST 'https://api.zizy.io/transaction' \
--header 'x-api-key: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "merchant_name": "APPLE.COM/BILL",
    "transaction_type": "CARD_TRANSACTION"
}'

response:

{
    "visual_enrichments": {
        "merchant_clean_name": "Apple",
        "merchant_logo_link": "https://storage.googleapis.com/demozizy/1227.png",
        "merchant_category": "NOT_FOUND",
        "merchant_website": "www.apple.com",
        "google_places_id": "NOT_FOUND"
    },
    "merchant_location": {
        "enabled": false
    },
    "subscriptions": {
        "enabled": false
    },
    "co2_footprint": {
        "enabled": false
    }
}

2. Same example - with MCC

curl --location --request POST 'https://api.zizy.io/transaction' \
--header 'x-api-key: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "merchant_name": "APPLE.COM/BILL",
    "transaction_type": "CARD_TRANSACTION",
    "merchant_category_code": "5735"
}

response:

{
    "visual_enrichments": {
        "merchant_clean_name": "Apple",
        "merchant_logo_link": "https://storage.googleapis.com/demozizy/1227.png",
        "merchant_category": "Media & Electronics",
        "merchant_website": "www.apple.com",
        "google_places_id": "NOT_FOUND"
    },
    "merchant_location": {
        "enabled": false
    },
    "subscriptions": {
        "enabled": false
    },
    "co2_footprint": {
        "enabled": false
    }
}

3. Visual enrichments & subscription

curl --location --request POST 'https://api.zizy.io/transaction' \
--header 'x-api-key: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "transaction_type": "CARD_TRANSACTION",
    "merchant_name": "APPLE.COM/BILL",
    "merchant_country": "IRL",
    "merchant_category_code": "5735",
    
    "transaction_id": "3214314312",
    "transaction_timestamp": "Fri, 16 Dec 2022 16:54:36 GMT",
    "transaction_amount": 4.99,
    "transaction_currency": "USD",

    "user_id": "123456",
    "account_id": "145678",
    "card_id": "1924504"
}'

response:

{
    "visual_enrichments": {
        "merchant_clean_name": "Apple",
        "merchant_logo_link": "https://storage.googleapis.com/demozizy/1227.png",
        "merchant_category": "Media & Electronics",
        "merchant_website": "www.apple.com",
        "google_places_id": "NOT_FOUND"
    },
    "merchant_location": {
        "enabled": false
    },
    "subscriptions": {
        "enabled": true,
        "is_recurring": true
    },
    "co2_footprint": {
        "enabled": false
    }
}

4. Visual enrichments with merchant location & co2 footprint

curl --location --request POST 'https://api.zizy.io/transaction' \
--header 'x-api-key: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "transaction_type": "CARD_TRANSACTION",
    "merchant_name": "APPLE STORE R358",
    "merchant_city": "Berlin"
    "merchant_country": "DEU",
    "merchant_category_code": "5735",
    
    "transaction_id": "222453121",
    "transaction_timestamp": "Sun, 18 Dec 2022 12:14:46 GMT",
    "transaction_amount": 1000,
    "transaction_currency": "USD",

    "user_id": "123456",
    "account_id": "145678",
    "card_id": "1924504"
}'

response:

{
    "visual_enrichments": {
        "merchant_clean_name": "Apple Store",
        "merchant_logo_link": "https://storage.googleapis.com/demozizy/1227.png",
        "merchant_category": "Media & Electronics",
        "merchant_website": "www.apple.com",
        "google_places_id": "NOT_FOUND"
    },
    "merchant_location": {
        "enabled": true,
        "address": {
            "street": "Kurfürstendamm 26",
            "city": "Berlin",
            "zip_code": "10719",
            "country": "Germany"
        },
        "coordinates": {
            "lat": 52.5035478,
            "long": 13.328715
        }
    },
    "subscriptions": {
        "enabled": true,
        "is_recurring": true
    },
    "co2_footprint": {
        "enabled": true,
        "emissions": 78000
    }
}