API List Overview

2024-09-20 10:09

Below are the overview of APIs you might use, please use as appropriate.

1. Via Brand Channel

API Type	API	Description
Authorization	NA	NA
Membership Card	/{Merchant’s tag}/points/membercard/create	A webhook you provided to AlipayHK for creating membership in your system.
	/api/open/alipay/v1/ipass/pass/manage/createPass	Use this API to create membership card in AlipayHK app.
	/api/open/alipay/v1/ipass/pass/manage/updatePass	Use this API to update the membership card in AlipayHK app.
Transaction Data	/{Merchant’s tag}/points/bill/notify	A webhook you provided to AlipayHK for sending transaction information of authorized user.

2 Via Mini-App

API Type	API	Description
Authorization	JSAPI: my.getAuthCode scope: auth_base & SCOPE_USER_BILL API: /api/open/v2/authorizations/applyToken	Use these APIs to get user authorization.
Membership card	/api/open/alipay/v1/ipass/pass/manage/createPass	Use this API to create membership card in AlipayHK app.
Membership card	/api/open/alipay/v1/ipass/pass/manage/updatePass	Use this API to update the membership card in AlipayHK app.
Transaction data	/{Merchant’s tag}/points/bill/notify	A webhook you provided to AlipayHK for sending transaction information of authorized user.