The purpose of this documentation is to provide a programmer’s guide to connect with MEZZOFY COUPON PORTAL. To do this, SOME MINOR PROGRAMMING VIA JAVA or any programming language (PHP, ASP.NET or Ruby, etc) that interfaces with the web server must be performed by the merchant’s. This documentation provides sample code to demonstrate how to connect and receive the relevant information variables back into your website or apps (iOS and Android) via some programming.
The MEZZOFY COUPON PORTAL is a secure customer engagement engine that provides an interface for website or apps that requires real-time digital coupon and digital payment processing. The merchant’s server can connect via https with the MEZZOFY COUPON PORTAL to get a real-time digital coupon and digital payment authorization. It is up to the merchant to do whatever pre and post-processing that is required, such as storing coupon / wallet information, sending email notification, and logging of coupon / wallet transactions.
The merchant's website or apps must be able to generate a unique Userid and Running Number for the coupon transaction and have a URL that is a working script for the MEZZOFY COUPON PORTAL to return the authorization information.
What can I do with the MEZZOFY COUPON PORTAL API?
With the APIs, you can:
Module | Description |
Merchant | Merchant Profile Management View/Create/Update |
Merchant Site | Merchant Site Management View/Create/Update |
Merchant User | Merchant User Management View/Create/Update |
Coupon | Coupon Management View/Create/Update |
Payment | Payment Management Support PayPal Express Support GlobalPay |
Customer | Customer Management View/Create/Update |
Push Notification | Push Notification Management for Merchant and Customer View/Create |
Module | Description |
Customer | Customer Profile Management |
Membership | Membership Management Membership Tier |
Loyalty Points | Loyalty Points Management Reward Points Support Top Up Support Redeem Welcome Points Birthday Points |
The responsibility of linking a web site with Mezzofy to the owner of the apps or website or whoever is responsible for the website in general. Thoughts Igniter support staff will try their best to assist, but not responsible for ensuring that a website or apps is programmed properly for use with Mezzofy. Merchants that are unable to implement the HTML/CGI/ASP/JSP/PHP/ASP.NET requirements for using Mezzofy should consult with a web designer/web programmer/apps designer/apps programmer for assistance.
In order to use Mezzofy, you must have a few additional lines of HTML code placed in the web page file that represents the final coupon page of a website or native apps programming code.
The following guidelines are intended to identify the Mezzofy requirements and provide basic HTML code snippet examples of how to implement these requirements.
API endpoints are mapped to your account domain:
http://domain.mezzofy.com/path/to/api
When you have configured SSL in your account (see how to configure SSL), your API calls must point to the SSL endpoint—simply change the http:// part of the endpoint to https://.
https://domain.mezzofy.com/path/to/api
For brevity, all further references in document relating to API endpoints will use the default http.
How does it work? Who can access my CRM? Can everybody see my data?
"Thou shall not pass." Unless you authenticate your ID
Mezzofy uses Oauth1.0a Authorization with HMAC-SHA1. This means, for authentication, you can use the same username and password you use when logging into your CRM. Or, you can use your personal API key and secret provided by us.
https://domain.mezzofy.com/path/to/api
Where can I find my API key?How do I access the information? What are the resources available via the API?
Every single piece of information or data - be it a customer's ID or the coupon ID - can be identified by its own unique identifier or "URL". If you want your data from the CRM, whether via your smartphone app or via a third party service, you need this identifier. All URIs follow a specific format and that format is:
http://domain.mezzofy.com/resource_name
Note:We have shortened API resource URL throughout this document. Prefix your support domain name to the resource handle.
What API commands are used by Mezzofy?
Mezzofy APIs have been implemented as plain JSON over HTTP and use the following REST Commands:
Method / Command | Purpose |
POST | Create one or more records |
GET | Fetch one or more records |
PUT | Update one or more records |
DELETE | Remove one or more records |
Will everyone have the same access rights?
No, certainly not. You can access the data depends on the permissions available in the Mezzofy profile and you can able to view the data that belongs to you.
Whenever API response returns a list like coupon listing, merchant list requires paginated. Instead of scroll through the responses, add GET request parameter page=[n] (n=page number) to your request. By default Page number starts with 1 and each page size contains 20 records.
Represents a country and location(s) within a country. Merchant is associated with a country and merchant outlet is associated with a location(s). Merchant will be created along with country via "Create New Merchant" API. The id of the country will be same as that of associated merchant id if not explictly set. Merchant Outlet will be created along with location via "Create New Merchant Outlet" API. The id of the location will be same as that of associated merchant id if not explictly set.
Retrieves the list of Countries.
You must pass all the following fields (unless it’s stated optional) to the MEZZOFY COUPON PORTAL Form (GET method is advised). To work properly, the fields must be named exactly (case-sensitive) as they are named here:
Field | Type | Description |
countryCode | CHAR[2] | Country Code |
countryName | CHAR[250] | Country Name |
countryStatus | CHAR[1] | Country Status "A" = Active "N" = Not Active |
Country Code | Country Name |
HK | Hong Kong |
MC | Macau |
CN | China |
SG | Singapore |
TW | Taiwan |
KR | Korea |
JP | Japan |
TH | Thailand |
MY | Malaysia |
PH | Philippines |
ID | Indonesia |
IN | India |
AU | Australia |
US | United States |
EU | Europe |
Currently two types of Merchants used in Mezzofy, namely "Master Merchant" and "Generic Merchant". Master Merchant is referred as a market place which manage a group of Generic Merchant product and service with Coupons. Generic Merchant manages their own product and service with Coupons.
Field | Type | Description |
country_code | CHAR[2] Read Only |
Country Code |
merchant_id | CHAR[4] Read Only |
Merchant ID |
merchant_code | VARCHAR[100] Mandatory |
Merchant Code |
merchant_type | VARCHAR[1] Mandatory |
Merchant Type "G" = Generic "A" = Aggregator |
merchant_name | VARCHAR[250] Mandatory |
Merchant Name |
merchant_desc | VARCHAR[500] Mandatory |
Merchant Description |
merchant_logourl | VARCHAR[255] | Merchant Logo URL Format JPG/PNG Max Size 300KB |
merchant_imageurl | VARCHAR[255] | Merchant Image URL Format JPG/PNG Max Size 300KB |
merchant_remark | VARCHAR[250] | Merchant Remark |
merchant_tc | VARCHAR[2000] | Merchant Terms and Conditions |
profile_status | VARCHAR[1] | Merchant Profile Status |
merchant_email | VARCHAR[100] | Merchant Profile Status |
merchant_hotline | VARCHAR[250] | Merchant Hotline |
merchant_status | VARCHAR[1] Mandatory |
Merchant Status "A" = Active "N" = Not Active |
expiry_date | DATETIME Read Only |
Expiry Date and Time |
channel_code | VARCHAR[20] Mandatory |
Channel Code |
currency | VARCHAR[10] Mandatory |
Currency |
youtube_url | VARCHAR[255] Mandatory |
Youtube URL |
facebook_url | VARCHAR[255] Mandatory |
Facebook URL |
twitter_url | VARCHAR[255] Mandatory |
Twitter URL |
website_url | VARCHAR[255] Mandatory |
Website URL |
instagram_url | VARCHAR[255] Mandatory |
Instagram URL |
whatsup_url | VARCHAR[255] Mandatory |
WhatsApp URL |
online_shop_url | VARCHAR[255] Mandatory |
Online Shop URL |
merchant_timezone | VARCHAR[100] Mandatory |
Merchant UTC Time Zone |
hashCode | VARCHAR[12] Read Only |
Merchant Hash Code |
update_by | VARCHAR[100] Read Only |
Last Updated Date and Time |
createdOn | DATETIME Read Only |
Created Date and Time |
updateOn | DATETIME Read Only |
Last Updated Date and Time |
Create a Merchant details.
You must pass all the following fields (unless it’s stated optional) to the MEZZOFY COUPON PORTAL Form (POST method is advised). To work properly, the fields must be named exactly (case-sensitive) as they are named here:
To view a Merchant details.
You must pass all the following fields (unless it’s stated optional) to the MEZZOFY COUPON PORTAL Form (GET method is advised). To work properly, the fields must be named exactly (case-sensitive) as they are named here:
Update a Merchant details.
You must pass all the following fields (unless it’s stated optional) to the MEZZOFY COUPON PORTAL Form (PUT method is advised). To work properly, the fields must be named exactly (case-sensitive) as they are named here:
Get the merchant list.
You must pass all the following fields (unless it’s stated optional) to the MEZZOFY COUPON PORTAL Form (GET method is advised). To work properly, the fields must be named exactly (case-sensitive) as they are named here:
Create new subscription details.
You must pass all the following fields (unless it’s stated optional) to the MEZZOFY COUPON PORTAL Form (POST method is advised). To work properly, the fields must be named exactly (case-sensitive) as they are named here:
The followings are the error codes used in the Merchant module or function.
Error Code | Description |
4201 | Invalid credential - Email or password is not found / matching |
4202 | Invalid credential - Email is empty |
4203 | Merchant is not found |
4204 | Requested Merchant details are not found |
4205 | Failed to create new merchant. Please check the input parameters |
4206 | Merchant code is found already |
4207 | Failed to update merchant details. Please check the input parameters |
4208 | Requested campaign details are not found |
Merchant Site is assoicated to Merchant directly where each Merchant could operates and manage multiple sites.
Field | Type | Description |
merchant_id | CHAR[4] Read Only |
Merchant ID |
site_id | CHAR[5] Read Only |
Merchant Site ID |
site_name | VARCHAR[250] Mandatory |
Merchant Site Name |
site_desc | VARCHAR[500] | Merchant Site Description |
site_address | VARCHAR[300] | Merchant Site Address |
site_latitude | DOUBLE | Merchant Site Latitude |
site_longitude | DOUBLE | Merchant Site Longtitude |
site_location | CHAR[3] | Location ID |
site_contact | CHAR[100] | Merchant Site Contact |
site_email_id | VARCHAR[150] | Merchant Site Email |
site_imageurl | CHAR[248] | Merchant Site Image URL Format JPG/PNG Max Size 300KB |
site_seq_no | INTEGER[11] | Merchant Site Sequence Number |
site_redeem_pass | VARCHAR[10] | Merchant Site Redemm Pass Code |
site_display_wallet | VARCHAR[10] | Merchant Site Wallet Display |
location_id | CHAR[6] | Merchant Site Location ID |
pickup_delivery | VARCHAR[1] | Merchant Site Pickup Details |
member_gln | VARCHAR[20] | Merchant Member GLN |
remote_type | VARCHAR[1] | Merchant Site RemoteType |
redemption_site_id | CHAR[6] | Redemption SiteID |
siteOnlineStatus | CHAR[1] Mandatory |
Merchant Site Online Status "A" = Active "N" = Not Active |
siteStatus | VARCHAR[1] Mandatory |
Merchant Site Status "A" = Active "N" = Not Active |
hashCode | CHAR[12] Read Only |
Merchant Site Hash Code |
updated_by | VARCHAR[100] | Merchant Site Last Updated Name |
created_on | DATETIME Read Only |
Created Date and Time |
updated_on | DATETIME Read Only |
Last Updated Date and Time |
Filter By | Handle |
Site Online Status | siteOnlineStatus |
Site Status | siteStatus |
Site Location | siteLocation |
Sort By | Handle |
Site Sequence Number | siteSeqNo |
Site Name | siteName |
Create a Merchant Site details.
You must pass all the following fields (unless it’s stated optional) to the MEZZOFY COUPON PORTAL Form (POST method is advised). To work properly, the fields must be named exactly (case-sensitive) as they are named here:
View a Merchant Site details.
You must pass all the following fields (unless it’s stated optional) to the MEZZOFY COUPON PORTAL Form (GET method is advised). To work properly, the fields must be named exactly (case-sensitive) as they are named here:
Update a Merchant Site details.
You must pass all the following fields (unless it’s stated optional) to the MEZZOFY COUPON PORTAL Form (PUT method is advised). To work properly, the fields must be named exactly (case-sensitive) as they are named here:
View a Merchant Site list.
You must pass all the following fields (unless it’s stated optional) to the MEZZOFY COUPON PORTAL Form (GET method is advised). To work properly, the fields must be named exactly (case-sensitive) as they are named here:
Select a Merchant Site details.
You must pass all the following fields (unless it’s stated optional) to the MEZZOFY COUPON PORTAL Form (POST method is advised). To work properly, the fields must be named exactly (case-sensitive) as they are named here:
Perform log out.
You must pass all the following fields (unless it’s stated optional) to the MEZZOFY COUPON PORTAL Form (GET method is advised). To work properly, the fields must be named exactly (case-sensitive) as they are named here:
The followings are the error codes used in the Merchant Site module or function.
Error Code | Description |
4301 | No site is found |
4302 | Requested Site details are not found |
4303 | Site is found |
4304 | Failed to select or choose the site. Please check the input parameters |
4305 | Redeem site is already in use. |
4306 | Failed to create new site. Please check the input parameters |
4307 | Failed to update site details. Please check the input parameters |
4308 | Requested resource (or) merchant code is already found |
There are two types of Merchant in Mezzofy. The Master Merchant and Generic Merchant. Master Merchant is refer as a market place which manage a group of Generic Merchant product and service with Coupons. Generic Merchant manage their own product and service with Coupons.
Field | Type | Description |
merchantId | CHAR[5] Read Only |
Merchant ID |
sitetId | CHAR[5] | Site ID |
userId | CHAR[5] Read Only |
User ID |
userCode | CHAR[50] Mandatory |
User Code |
userLogin | CHAR[40] Mandatory |
User Login |
userFirstName | CHAR[50] Mandatory |
User First Name |
userLastName | CHAR[50] | User Last Name |
userDisplayName | CHAR[100] Mandatory |
User Display Name |
userDoj | DDMMYYYY | User Date of Join |
userAddress | CHAR[250] | User Address |
userCountry | CHAR[50] | User Country |
userPostalCode | CHAR[10] | User Postal Code |
userEmail | CHAR[40] | User Email |
userMobile | CHAR[15] | User Mobile |
userImageurl | CHAR[250] | User Image URL |
userStatus | CHAR[1] Mandatory |
User Status "A" = Active "N" = Not Active |
hashCode | CHAR[12] Read Only |
Merchant Site Hash Code |
updateOn | CHAR[30] Read Only |
Last Updated Date and Time |
Create a Merchant User details.
You must pass all the following fields (unless it’s stated optional) to the MEZZOFY COUPON PORTAL Form (POST method is advised). To work properly, the fields must be named exactly (case-sensitive) as they are named here:
View a Merchant User details.
You must pass all the following fields (unless it’s stated optional) to the MEZZOFY COUPON PORTAL Form (GET method is advised). To work properly, the fields must be named exactly (case-sensitive) as they are named here:
Update a Merchant User details.
You must pass all the following fields (unless it’s stated optional) to the MEZZOFY COUPON PORTAL Form (PUT method is advised). To work properly, the fields must be named exactly (case-sensitive) as they are named here:
View a Merchant User list.
You must pass all the following fields (unless it’s stated optional) to the MEZZOFY COUPON PORTAL Form (GET method is advised). To work properly, the fields must be named exactly (case-sensitive) as they are named here:
Authorization for a Merchant User.
You must pass all the following fields (unless it’s stated optional) to the MEZZOFY COUPON PORTAL Form (POST method is advised). To work properly, the fields must be named exactly (case-sensitive) as they are named here:
Coupon management helps the business to market their services (promote sales) and attract new customers. In other words, one of the best way to engage customers and drive sales through the use of coupons. This module allows to create, distribute and track the generated coupons.
Coupon is generated by Campaign (Campaign assoicated with Merchants and Products. Also it can be from Campaign Group). While creation of Coupon, the type is defined as either "Charge" or "Free". Charge coupons should go through the payment (by default Paypal gateway is integrated) before coupon issue. When the customer redeemed the Coupon to get the discount while purchasing the product application perform the validation in one of the followings:
a) Scan - By scanning the embedded bar code will redeem
b) Code - An unique coupon code is embedded with coupon
c) Pin - Validate the Pin with server
d) Mass Redeem - This can be done by QR scanner, customer will be able to redeem coupons in-store in seconds
Coupon module is integrated with Campaign module which allows user to create and allocate coupon(s).
Field | Type | Description |
campaignId | CHAR[6] |
Campaign ID |
merchantId | CHAR[4] |
Merchant ID |
campaign_code | VARCHAR[100] |
Campaign Code |
campaign_name | VARCHAR[250] |
Campaign Name |
campaign_desc | VARCHAR[2500] |
Campaign Description |
selling_price | DOUBLE |
Selling Price |
orginal_price | DOUBLE |
Original Price |
brand | VARCHAR[1] |
Brand Type |
campaign_status | VARCHAR[1] |
Campaign Status |
campaign_tc | VARCHAR[2000] |
Campaign Terms & Condition |
campaign_remark | VARCHAR[250] |
Campaign Remark |
campaign_note1 | VARCHAR[250] |
Campaign Notes |
campaign_note2 | VARCHAR[250] |
Campaign Notes |
campaign_note3 | VARCHAR[250] |
Campaign Notes |
campaign_uuid | VARCHAR[50] |
Campaign Universal Unique Identifier |
daily_limit | INTERGER[10] |
Campaign Daily Limit |
pack_qty | INTERGER[10] |
Pack Quantity |
booking | VARCHAR[1] |
Booking |
outcall | VARCHAR[1] |
OutCall |
type_service | VARCHAR[1] |
Type of Service |
review_url | VARCHAR[256] Read Only |
Review URL |
video_url | VARCHAR[256] Read Only |
Video URL |
email_staff | VARCHAR[1] |
Email Staff |
coupon_over | VARCHAR[1] |
Coupon Over |
expiry_days | INTEGER[11] |
Expiry Days |
day_filter | VARCHAR[1] |
Day Filter |
from_date | DATETIME |
From Date |
to_date | DATETIME |
To Date |
campaign_type | VARCHAR[1] |
Campaign Type |
total_redeem | INTEGER[11] |
Total Redeem |
allocation_count | INTEGER[11] |
Allocation Count |
coupon_url | INTEGER[11] |
Coupon URL |
daily_limit_type | VARCHAR[1] |
Daily Limit Type |
online_redeem | VARCHAR[100] |
Online Redeem |
online_shop_url | VARCHAR[255] |
Online Redeem |
qr_url | VARCHAR[255] |
QR URL |
youtube_url | LONGTEXT |
youtube URL |
gtin | VARCHAR[20] |
GTIN |
publish | VARCHAR{1} |
Publish Status |
custom_data | LONGTEXT |
Custom Data |
hash_code | CHAR[12] |
Campaign Hashcode |
created_on | DATETIME Read Only |
Created Date and Time |
updateOn | DATETIME Read Only |
Last Updated Date and Time |
Note: Campgrp = Campaign Group
Create a Campaign details.
You must pass all the following fields (unless it’s stated optional) to the MEZZOFY COUPON PORTAL Form (POST method is advised). To work properly, the fields must be named exactly (case-sensitive) as they are named here:
View a specific Campaign details.
You must pass all the following fields (unless it’s stated optional) to the MEZZOFY COUPON PORTAL Form (GET method is advised). To work properly, the fields must be named exactly (case-sensitive) as they are named here:
Update a Campaign details.
You must pass all the following fields (unless it’s stated optional) to the MEZZOFY COUPON PORTAL Form (PUT method is advised). To work properly, the fields must be named exactly (case-sensitive) as they are named here:
View a Campaign list.
You must pass all the following fields (unless it’s stated optional) to the MEZZOFY COUPON PORTAL Form (GET method is advised). To work properly, the fields must be named exactly (case-sensitive) as they are named here:
Note: The response will give the assoicated Campagin group details along with Campaign details
View a Merchant Campaign published list.
You must pass all the following fields (unless it’s stated optional) to the MEZZOFY COUPON PORTAL Form (GET method is advised). To work properly, the fields must be named exactly (case-sensitive) as they are named here:
Note: The response will give the assoicated Campagin group details along with Campaign details
To view a Customer Campaign list.
You must pass all the following fields (unless it’s stated optional) to the MEZZOFY COUPON PORTAL Form (GET method is advised). To work properly, the fields must be named exactly (case-sensitive) as they are named here:
To view a Customer Campaign.
You must pass all the following fields (unless it’s stated optional) to the MEZZOFY COUPON PORTAL Form (GET method is advised). To work properly, the fields must be named exactly (case-sensitive) as they are named here:
Field | Type | Description |
campgrpId | CHAR[6] |
Campaign Group ID |
campgrpName | CHAR[6] |
Campaign Group Name |
campgrpIdImageurl | CHAR[250] |
Campaign Group Image Url |
campgrpSeq | Integer |
Campaign Group Sequence Number |
campgrpStatus | CHAR[1] |
Campaign Group Status A - Active N - Not Active |
hashCode | CHAR[12] |
Campaign Group Hash Code |
updateOn | CHAR[30] Read Only |
Last Updated Date and Time |
Note: Campgrp = Campaign Group
Create a Campaign group details.
You must pass all the following fields (unless it’s stated optional) to the MEZZOFY COUPON PORTAL Form (POST method is advised). To work properly, the fields must be named exactly (case-sensitive) as they are named here:
View a specific Campaign group details.
You must pass all the following fields (unless it’s stated optional) to the MEZZOFY COUPON PORTAL Form (GET method is advised). To work properly, the fields must be named exactly (case-sensitive) as they are named here:
Update a Campaign group details.
You must pass all the following fields (unless it’s stated optional) to the MEZZOFY COUPON PORTAL Form (PUT method is advised). To work properly, the fields must be named exactly (case-sensitive) as they are named here:
View a Campaign group list.
You must pass all the following fields (unless it’s stated optional) to the MEZZOFY COUPON PORTAL Form (GET method is advised). To work properly, the fields must be named exactly (case-sensitive) as they are named here:
Field | Type | Description |
allocationId | CHAR[6] |
Allocation ID |
allocationCount | Integer |
Allocation Count A - Active N - Not Active |
allocationRefers | CHAR[100] |
Allocation Reference |
allocationRemark | CHAR[2000] |
Allocation Remarks |
updateOn | CHAR[30] Read Only |
Last Updated Date and Time |
To Create a Campaign allocation (Reserves Coupon Range) details.
You must pass all the following fields (unless it’s stated optional) to the MEZZOFY COUPON PORTAL Form (POST method is advised). To work properly, the fields must be named exactly (case-sensitive) as they are named here:
Field | Type | Description |
couponId | CHAR[10] |
Coupon ID |
productId | CHAR[10] |
Product ID |
poId | CHAR[10] |
Purchase Order ID |
podetailId | CHAR[10] |
Purchase Order Detail ID |
merchantId | CHAR[4] |
Merchant ID |
customerId | CHAR[6] |
Customer ID |
couponName | CHAR[200] |
Coupon Name |
couponNo | CHAR[50] |
Coupon No |
expiryDate | DATE |
Expiry Date |
startDate | DATE |
Start Date |
couponStatus | CHAR[1] |
Coupon Status C - Created or Issued R - Reedeemed A - Available L - Allocated?? |
productNote1 | CHAR[250] |
Product Note1 |
productNote2 | CHAR[250] |
Product Note2 |
productNote3 | CHAR[250] |
Product Note3 |
productDesc | CHAR[250] |
Product Description |
productImageurl | CHAR[250] |
Product Image URL |
referencesEmail | CHAR[150] |
ReferencesEmail |
masscouponId | CHAR[100] |
Mass Coupon ID |
sellingPrice | Double |
Selling Price |
originalPrice | Dobule |
Original Price |
productTc | CHAR[200] |
Prodct Terms and Conditions |
hashCode | CHAR[12] |
????? |
updateOn | CHAR[30] Read Only |
Last Updated Date and Time |
View a Customer Coupon details.
You must pass all the following fields (unless it’s stated optional) to the MEZZOFY COUPON PORTAL Form (GET method is advised). To work properly, the fields must be named exactly (case-sensitive) as they are named here:
View a Customer list.
You must pass all the following fields (unless it’s stated optional) to the MEZZOFY COUPON PORTAL Form (GET method is advised). To work properly, the fields must be named exactly (case-sensitive) as they are named here:
A purchase order is a source document to place an order with a Merchant. It typically lists the date of the order, shipping information, shipping date, discount terms, description of the goods, price, quantity, and PO number. So basically, an order includes everything about the transaction.
Field | Type | Description |
poId | CHAR[10] |
Product Order ID |
customerId | CHAR[6] |
Customer ID A - Active N - Not Active |
poDate | Date/Time |
Purchase Order Date |
poNo | CHAR[50] |
Purchase Order No |
poTotal | Double |
Purchase Order Total |
poStatus | CHAR[6] |
Place Order Status A - Active Not Yet Paid P - Paid |
payReceipt | CHAR[200] |
Pay Receipt |
payResponse | CHAR[5] |
Pay Response |
txnFrom | CHAR[6] |
Transaction From |
txnTo | CHAR[6] |
Transaction To |
payToken | CHAR[50] |
Pay Token |
rewardPoints | Double |
Reward Points |
hashCode | CHAR[12] |
????? |
updateOn | CHAR[30] Read Only |
Last Updated Date and Time |
Create Coupon Purchase Order details.
You must pass all the following fields (unless it’s stated optional) to the MEZZOFY COUPON PORTAL Form (POST method is advised). To work properly, the fields must be named exactly (case-sensitive) as they are named here:
View a Coupon Purchase Order details.
You must pass all the following fields (unless it’s stated optional) to the MEZZOFY COUPON PORTAL Form (GET method is advised). To work properly, the fields must be named exactly (case-sensitive) as they are named here:
Update a Coupon Purchase Order details.
You must pass all the following fields (unless it’s stated optional) to the MEZZOFY COUPON PORTAL Form (PUT method is advised). To work properly, the fields must be named exactly (case-sensitive) as they are named here:
View Coupon Purchase Order list details.
You must pass all the following fields (unless it’s stated optional) to the MEZZOFY COUPON PORTAL Form (GET method is advised). To work properly, the fields must be named exactly (case-sensitive) as they are named here:
You must pass all the following fields (unless it’s stated optional) to the MEZZOFY COUPON PORTAL Form (GET method is advised). To work properly, the fields must be named exactly (case-sensitive) as they are named here:
You must pass all the following fields (unless it’s stated optional) to the MEZZOFY COUPON PORTAL Form (GET method is advised). To work properly, the fields must be named exactly (case-sensitive) as they are named here:
You must pass all the following fields (unless it’s stated optional) to the MEZZOFY COUPON PORTAL Form (POST method is advised). To work properly, the fields must be named exactly (case-sensitive) as they are named here:
You must pass all the following fields (unless it’s stated optional) to the MEZZOFY COUPON PORTAL Form (POST method is advised). To work properly, the fields must be named exactly (case-sensitive) as they are named here:
You must pass all the following fields (unless it’s stated optional) to the MEZZOFY COUPON PORTAL Form (POST method is advised). To work properly, the fields must be named exactly (case-sensitive) as they are named here:
You must pass all the following fields (unless it’s stated optional) to the MEZZOFY COUPON PORTAL Form (POST method is advised). To work properly, the fields must be named exactly (case-sensitive) as they are named here:
You must pass all the following fields (unless it’s stated optional) to the MEZZOFY COUPON PORTAL Form (POST method is advised). To work properly, the fields must be named exactly (case-sensitive) as they are named here:
The followings are the error codes used in the Coupon module or function.
Error Code | Description |
4101 | No purchase order is found |
4102 | No coupon is found |
4103 | No open coupon is found |
4104 | No allocation coupon is found |
4105 | Coupon allocation is failed Please check the input parameters |
4106 | No audit trail records are found |
4107 | Requested resource (or) merchant code is already found |
4108 | Coupons are not found |
4109 | Referred user is not found |
4110 | Guest user is not allowed to do this transaction |
4111 | Failed to create purchase order. Please check the input parameters |
4112 | The coupon is not valid |
Merchant can leveage on our integrated payment gateway with PayPal. Simplpy create your own account witht the payment service provider. Get the merchant account details from PayPal and input use it to pass as a parameter to process payment. All payment will be credit directly to your own PayPal account. No middle man or another mark up fees. However, normal PayPal fees applies for using their service.
No PayPal account yet? Sign Up Now.
Field | Type | Description |
merchantId | CHAR[5] Read Only |
Merchant ID |
paymentId | CHAR[3] | Payment ID |
paymentName | CHAR[150] | Payment Name |
paymentLogourl | CHAR[250] | Payment Logo URL |
paymentType | CHAR[150] | Payment Type |
paymentEnviornment | CHAR[1] | Payment Enviornment "P" = Production "S" = Sandbox |
paymentStatus | CHAR[1] Mandatory |
Payment Status "A" = Active "N" = Not Active |
hashCode | CHAR[12] Read Only |
Product Hash Code |
updateOn | CHAR[30] Read Only |
Last Updated Date and Time |
View a Payment Setup details.
You must pass all the following fields (unless it’s stated optional) to the MEZZOFY COUPON PORTAL Form (GET method is advised). To work properly, the fields must be named exactly (case-sensitive) as they are named here:
View a Payment Setup list.
You must pass all the following fields (unless it’s stated optional) to the MEZZOFY COUPON PORTAL Form (GET method is advised). To work properly, the fields must be named exactly (case-sensitive) as they are named here:
Create a Payment Setup details.
You must pass all the following fields (unless it’s stated optional) to the MEZZOFY COUPON PORTAL Form (POST method is advised). To work properly, the fields must be named exactly (case-sensitive) as they are named here:
Update a Payment Setup details.
You must pass all the following fields (unless it’s stated optional) to the MEZZOFY COUPON PORTAL Form (PUT method is advised). To work properly, the fields must be named exactly (case-sensitive) as they are named here:
Field | Type | Description |
merchantId | CHAR[5] Read Only |
Merchant ID |
paymentId | CHAR[3] | Payment ID |
paymentmerchantId | CHAR[150] | Payment Merchant ID |
paymentdetailId | CHAR[6] | Payment Detail ID |
paymentKey | CHAR[150] | Payment Key |
paymentToken | CHAR[250] | Payment Token |
paymentUrl | CHAR[250] | Payment URL |
paymentStatus | CHAR[1] Mandatory |
Payment Status "A" = Active "N" = Not Active |
hashCode | CHAR[12] Read Only |
Product Hash Code |
updateOn | CHAR[30] Read Only |
Last Updated Date and Time |
View a Payment Type Setup details.
You must pass all the following fields (unless it’s stated optional) to the MEZZOFY COUPON PORTAL Form (GET method is advised). To work properly, the fields must be named exactly (case-sensitive) as they are named here:
View a Payment Type Setup list.
You must pass all the following fields (unless it’s stated optional) to the MEZZOFY COUPON PORTAL Form (GET method is advised). To work properly, the fields must be named exactly (case-sensitive) as they are named here:
Create a Payment Type Setup details.
You must pass all the following fields (unless it’s stated optional) to the MEZZOFY COUPON PORTAL Form (POST method is advised). To work properly, the fields must be named exactly (case-sensitive) as they are named here:
Update a Payment Type Setup details.
You must pass all the following fields (unless it’s stated optional) to the MEZZOFY COUPON PORTAL Form (PUT method is advised). To work properly, the fields must be named exactly (case-sensitive) as they are named here:
View a Customer Payment.
You must pass all the following fields (unless it’s stated optional) to the MEZZOFY COUPON PORTAL Form (GET method is advised). To work properly, the fields must be named exactly (case-sensitive) as they are named here:
Field | Type | Description |
merchantId | CHAR[5] Read Only |
Merchant ID |
siteId | CHAR[5] Read Only |
Merchant Site ID |
custpayId | CHAR[10] | Customer Payment ID |
transactionAmount | DOUBLE | Transaction Amount |
referencesNo | CHAR[50] | Reference Number |
remark | CHAR[250] | Payment Remarks |
userId | CHAR[5] | Merchant User ID |
userLogin | CHAR[40] | Merchant User Login |
hashCode | CHAR[12] | Hash Code |
updateOn | CHAR[30] Read Only |
Last Updated Date and Time |
We provide the Customer data table to capture and assoicate with the coupons for link up in order to display what coupons does a customer have and profiling of the customer is possible as you expand the data to collect. It will work together with you existing CRM too.
Field | Type | Description |
merchant_id | VARCHAR[4] Read Only |
Merchant ID |
customer_id | VARCHAR[6] Read Only |
Customer ID |
customer_group_id | VARCHAR[6] | Customer Group ID |
customer_first_name | VARCHAR[100] | Customer First Name |
customer_last_name | VARCHAR[100] | Customer Last Name |
customer_username | VARCHAR[100] | Customer Username |
customer_password | CHAR[32] | Customer Password |
customer_email | VARCHAR[200] | Customer Email |
country_code | VARCHAR[2] | Customer Country |
customer_dob | DATE | Customer Date of Birth |
customer_mobile | VARCHAR[20] | Customer Mobile |
customer_gender | VARCHAR[1] | Customer Gender "M" = Male "F" = Female |
customer_address | VARCHAR[200] | Customer Address |
user_type | VARCHAR[1] | Customer Type "C" - Customer "A" - Agent "S" - Staff |
vip_no | VARCHAR[50] | Customer VIP Number |
dgvip_no | VARCHAR[50] | Customer DGVIP Number |
fb_token | VARCHAR[1000] | Customer Facebook Token |
customer_status | CHAR[1] Mandatory |
Customer Status "A" = Active "N" = Not Active |
customer_image_url | VARCHAR[258] Read Only |
Customer Image URL |
member_id | VARCHAR[100] Read Only |
Product Hash Code |
updated_by | CHAR[12] Read Only |
Product Hash Code |
hash_code | CHAR[12] Read Only |
Product Hash Code |
created_on | DATETIME Read Only |
Created Date and Time |
update_on | DATETIME Read Only |
Last Updated Date and Time |
Field | Type | Description |
merchantId | CHAR[5] Read Only |
Merchant ID |
customerId | CHAR[6] Read Only |
Customer ID |
customergroupId | CHAR[6] | Customer Group ID |
customergroupName | CHAR[100] | Customer Group Name |
dollarSpending | DOUBLE | Customer Dollar Spending |
rewardPoints | DOUBLE | Customer Rewards Points |
welcomePoints | DOUBLE | Customer Welcome Points |
customergroupStatus | CHAR[1] Mandatory |
Customer Status "A" = Active "N" = Not Active |
hashCode | CHAR[12] Read Only |
Product Hash Code |
updateOn | CHAR[30] Read Only |
Last Updated Date and Time |
Create a Customer details.
You must pass all the following fields (unless it’s stated optional) to the MEZZOFY COUPON PORTAL Form (POST method is advised). To work properly, the fields must be named exactly (case-sensitive) as they are named here:
View a Customer details.
You must pass all the following fields (unless it’s stated optional) to the MEZZOFY COUPON PORTAL Form (GET method is advised). To work properly, the fields must be named exactly (case-sensitive) as they are named here:
Update a Customer details.
You must pass all the following fields (unless it’s stated optional) to the MEZZOFY COUPON PORTAL Form (PUT method is advised). To work properly, the fields must be named exactly (case-sensitive) as they are named here:
View a Customer list.
You must pass all the following fields (unless it’s stated optional) to the MEZZOFY COUPON PORTAL Form (GET method is advised). To work properly, the fields must be named exactly (case-sensitive) as they are named here:
Create a Customer Group details.
You must pass all the following fields (unless it’s stated optional) to the MEZZOFY COUPON PORTAL Form (POST method is advised). To work properly, the fields must be named exactly (case-sensitive) as they are named here:
View a Customer Group details.
You must pass all the following fields (unless it’s stated optional) to the MEZZOFY COUPON PORTAL Form (GET method is advised). To work properly, the fields must be named exactly (case-sensitive) as they are named here:
Update a Customer Group details.
You must pass all the following fields (unless it’s stated optional) to the MEZZOFY COUPON PORTAL Form (PUT method is advised). To work properly, the fields must be named exactly (case-sensitive) as they are named here:
View a Customer Group list.
You must pass all the following fields (unless it’s stated optional) to the MEZZOFY COUPON PORTAL Form (GET method is advised). To work properly, the fields must be named exactly (case-sensitive) as they are named here:
The followings are the error codes used in the Customer module or function.
Error Code | Description |
4001 | Merchant Code is not found |
4002 | No Customer is found |
4003 | Merchant is not found |
4004 | Invalid credential - E-mail or password is not found / matching |
4005 | Invalid credential - Customer Email is empty |
4006 | Invalid Customer ID - Customer ID is not available |
4007 | Profile - Change password update is failed |
4008 | Profile - Customer Email already exists |
4009 | Profile - Requested Customer details are not found |
4010 | Profile - Customer Mobile is available |
4011 | Profile - Customer user name is available |
4012 | Failed to create new merchant. Please check the input parameters |
4013 | Failed to update customer details. Please check the input parameters |
We provide the Push Notificaitons for Customer and Merchant for communicaiton purpose.
A push notification is a message that pops up on a mobile device. Merchants can send them at any time to their customers.
Field | Type | Description |
notificationId | CHAR[20] | Notification ID |
customerId | CHAR[6] | Customer ID |
notificationTitle | CHAR[250] | Notification Title |
notificationDesc | CHAR[250] | Notification Description |
notificationType | CHAR[1] Mandatory |
Device Type "E" = Enable "D" = Disable |
eventId | CHAR[4] | Event ID |
couponId | CHAR[10] | Coupon ID |
createdOn | CHAR[30] Read Only |
Last Updated Date and Time |
Create Push Notification for Customer details.
You must pass all the following fields (unless it’s stated optional) to the MEZZOFY COUPON PORTAL Form (POST method is advised). To work properly, the fields must be named exactly (case-sensitive) as they are named here:
View a Customer Push Notificaiton details.
You must pass all the following fields (unless it’s stated optional) to the MEZZOFY COUPON PORTAL Form (GET method is advised). To work properly, the fields must be named exactly (case-sensitive) as they are named here:
Push Notification for Customer.
You must pass all the following fields (unless it’s stated optional) to the MEZZOFY COUPON PORTAL Form (GET method is advised). To work properly, the fields must be named exactly (case-sensitive) as they are named here:
TBD
Field | Type | Description |
notificationId | CHAR[20] | Notification ID |
customerId | CHAR[6] | Customer ID |
notificationTitle | CHAR[250] | Notification Title |
notificationDesc | CHAR[250] | Notification Description |
notificationType | CHAR[1] Mandatory |
Device Type "E" = Enable "D" = Disable |
eventId | CHAR[4] | Event ID |
couponId | CHAR[10] | Coupon ID |
createdOn | CHAR[30] Read Only |
Last Updated Date and Time |
View a Merchant Push Notificaiton details.
You must pass all the following fields (unless it’s stated optional) to the MEZZOFY COUPON PORTAL Form (GET method is advised). To work properly, the fields must be named exactly (case-sensitive) as they are named here:
Push Notification for Merchant.
You must pass all the following fields (unless it’s stated optional) to the MEZZOFY COUPON PORTAL Form (GET method is advised). To work properly, the fields must be named exactly (case-sensitive) as they are named here:
Create Push Notification for Merchant details.
You must pass all the following fields (unless it’s stated optional) to the MEZZOFY COUPON PORTAL Form (POST method is advised). To work properly, the fields must be named exactly (case-sensitive) as they are named here:
Tinkering begets innovation. Here are some of our working sample projects to integrate, customise and build amazing digital coupon experiences.
Reckon there's a way to get started, fast? Sure is. Here are some step-by-step tutorials on using our APIs, to work up some magic with integrations.