API list
Below are the overview of all the APIs might be used. You can choose the APIs depends on your own requirement. There are also some APIs need to be developed by merchant side.
1. Via Brand Channel
API Type | Index | API | Description | Direction | Developed by |
| 1.1 | NA | No API Integration needed | NA | NA |
| 2.1 | /{Merchant’s tag}/points/membercard/create | Uses for AlipayHK to create a membership card in Merchant side | AlipayHK --> Merchant |
|
2.2 | Uses for Merchant to create a membership card in AlipayHK app | Merchant --> AlipayHK |
| ||
2.3 | Uses for Merchant to update membership card information n AlipayHK app | Merchant --> AlipayHK |
| ||
| 3.1 | /{Merchant’s tag}/points/bill/notify | Uses for AlipayHK to send transaction information for authorized user | AlipayHK --> Merchant |
|
| 4.1 | NA | PMS colletcion and Maintenance will be conducted offline | NA | NA |
2 Via Mini-App
2.1 Auto Upload
API Type | Index | API | Description | Call Direction | Developed by |
| 1.1 | JSAPI: my.getAuthCode
| Uses for Merchant to get user authorization | Merchant --> AlipayHK |
|
| 2.1 | Uses for Merchant to create a membership card in AlipayHK app | Merchant --> AlipayHK |
| |
2.2 | Uses for Merchant to update membership card information n AlipayHK app | Merchant --> AlipayHK |
| ||
| 3.1 | /{Merchant’s tag}/points/bill/notify | Uses for AlipayHK to send transaction information for authorized user | AlipayHK --> Merchant |
|
| 4.1 | NA | Uses for Shopping Malls to collect PMS information | Merchant --> AlipayHK | NA |
2.2 Manual Upload
API Type | Index | API | Description | Call Direction | Developed by |
| 1.1 | JSAPI: my.getAuthCode
| Uses for Merchant to get user authorization | Merchant --> AlipayHK |
|
| 2.1 | Uses for Merchant to create a membership card in AlipayHK app | Merchant --> AlipayHK |
| |
2.2 | Uses for Merchant to update membership card information n AlipayHK app | Merchant --> AlipayHK |
| ||
| 3.1 | /api/open/alipayhk/businessdistrict/bill/query | Uses for Shopping Malls to query authorized user's transaction information | Merchant --> AlipayHK |
|
3.2 | JSAPI: my.navigateToMiniProgram | Uses for Shopping Malls mini-app to re-direct to the page for user transaction information submission *needs to contact SA team for enabling this API for your mini-app | Merchant --> AlipayHK |
| |
3.3 | Mini-APP funciton : onShow(options) * please contact SA team for details of this function | Uses for Shopping Malls to switch between to the user transaction information page and Mall's mini-app | Merchant --> AlipayHK |
| |
| 4.1 | /api/open/alipayhk/businessdistrict/circleStore/save | Uses for Shopping Malls to collect PMS information | Merchant --> AlipayHK |
|
4.2 | /api/open/alipayhk/businessdistrict/circleStore/queryPage | Uses for Shopping Malls to check PMS information collection result | Merchant --> AlipayHK |
|