One-Stop Cross-Border Shopping — Shop the World
UnionPay Content & Service Platform (UCSP) for Channel Partner
UnionPay Content & Service Platform (UCSP) for Service Provider
UnionPay Transportation Solutions
Through the country code, city, bank and keyword, users can query ATM information with latitude and longitude.
Periodic Update
Pay attention to the frequent changes in ATM data of financial institutions and acquiring institutions, and UnionPay international will update the data regularly。
Integration Convenience
ATM Locator API returns the longitude and latitude data, which can not only meet the query requirements, but also facilitate the integration with map app.
It is applicable for customers to query ATM information according conditions such as country code in PC or App. For APIs more suitable for LBS (Location Based Services)scenarios, please refer to ATM nearby API.
Access Flow:
1. API Caller apply to use APIs
2. UPI approve application, update white list and generate key pair, then provide API Caller the public key and user ID (appID)
Call Flow:
3. API Caller uses the public key to encrypt the request message which include caller’s user identity information
4. UPI verify API Caller’s identity, decrypt request message, and return response data encrypted by using private key.
Field name | Identifier | Type | Length | Request | Default value | Note | |
---|---|---|---|---|---|---|---|
Country Code | countryCode | N | 3 | M:Mandatory | "156" | A 3-digit numeric value, as defined by [ISO 3166], that indicates the country code. | |
City Name | cityName | S | 1-100 | O:Optional | The name of the city for an ATM location.The name shall be the response result from the ATM_CITY_AND_BANK_LIST_INQUIRY interface. | ||
Bank Name | bankName | S | 1-100 | O:Optional | The owner of the ATM.The name shall be the response result from the ATM_CITY_AND_BANK_LIST_INQUIRY interface. | ||
Keyword | keyword | S | 1-10 | O:Optional | Some words that used to match | ||
Page Number | pageNo | N | 1-10 | M:Mandatory | “1” | The page number where the response will start. | |
Page Size | pageSize | N | 1-10 | M:Mandatory | “20” | Maximum number of items to retrieve within the current page. |
Filed name | Identifier | Type | Length | Request | Default value | Note | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Message Response | msgResponse | Object | M:Mandatory | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Total Page | totalPage | N | 1-10 | M:Mandatory | “5” | The page number that the response will include. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Total Number | totalNo | N | 1-100 | M:Mandatory | “100” | The total number that the response will include. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ATM List | atmList | Array | M:Mandatory | The returned ATM list | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Field name | Identifier | Type | Length | Request | Default value | Note | |
---|---|---|---|---|---|---|---|
Country Code | countryCode | N | 3 | M:Mandatory | "156" | A 3-digit numeric value, as defined by [ISO 3166], that indicates the country code. |
Filed name | Identifier | Type | Length | Request | Default value | Note | |||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Message Response | msgResponse | Object | M:Mandatory | ||||||||||||||||||||||||||||
|
Country Name Chinese | countryNameCn | S | 1-100 | M:Mandatory | The Chinese name of the country. | |||||||||||||||||||||||||
Country Name English | countryNameEn | S | 1-100 | M:Mandatory | The English name of the country. | ||||||||||||||||||||||||||
City Name List | cityNameList | Array | M:Mandatory | “cityNameList”: [”Hangzhou”, ”Suzhou”] | The list of city name that supports ATM. | ||||||||||||||||||||||||||
Bank Name List | bankNameList | Array | M:Mandatory | “bankName”: [”Bank of Melbourne”, ”Bank of China”] | The list of bank name that supports ATM. |
UnionPay International has adopted unified security requirement, please refer to UPI Server-based API General Requirements for signature and encryption guide.
If you are UPI member, you need to fill in the Application Form of API Service Product with Terms and Conditions.
If not, you need to sign the Protocol of API Usage and fill in the Application Form of API Service Product.
Please submit order to contact Developer Team