Clearing House Statistics – Faster Payment System Addressing Service Registrations

API Detailed Documentation

API URL:

https://api.hkma.gov.hk/public/market-data-and-statistics/monthly-statistical-bulletin/banking/ch-statistics-fps-reg

API Data Enquiry

Output Fields (JSON) Swagger Format
Name Type Unit Of Measure Description
end_of_monthDateAs at end of
Year and Month in ISO format yyyy-mm, For example, 1997-01
mobile_personalNumberCountMobile phone number
Personal
mobile_corporateNumberCountMobile phone number
Corporate
mobile_subtotalNumberCountMobile phone number
Sub-total
email_personalNumberCountEmail address
Personal
email_corporateNumberCountEmail address
Corporate
email_subtotalNumberCountEmail address
Sub-total
fpsid_personalNumberCountFPS Identifier
Personal
fpsid_corporateNumberCountFPS Identifier
Corporate
fpsid_subtotalNumberCountFPS Identifier
Sub-total
total_personalNumberCountTotal
Personal
total_corporateNumberCountTotal
Corporate
total_grand_totalNumberCountTotal
Grand-total

Footnotes:

1. A user may have more than one registration with the FPS, as he/she may register the use of more than one account proxy, and more than one accounts when using mobile number or email address as the account proxy.

API Examples

Javascript Example

$.ajax({
url: 'https://api.hkma.gov.hk/public/market-data-and-statistics/monthly-statistical-bulletin/banking/ch-statistics-fps-reg?offset=0',
dataType:'json',
success:function(data){
alert('results found:'+ data.result.datasize)
}
});

Python Example

import urllib.request
url = 'https://api.hkma.gov.hk/public/market-data-and-statistics/monthly-statistical-bulletin/banking/ch-statistics-fps-reg?offset=0'
with urllib.request.urlopen (url) as req:
print (req.read())

How to use the APIs

To learn more, please visit API documentation.