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 current location or the specified longitude and latitude , developers can query the nearby ATM information. In necessary situation, customers can report wrong ATM information through this API.
Periodic Update:
ATM data and customers' feedback will be updated regulary.
Integration Convenience:
The returned total ATM information data includes longitude and latitude data, which can not only meet the query requirements, but also facilitate integration with map app.
Applicable for app side scenarios and 'where is ATM and how to go' app integration for LBS(Location Based Services ) scenarios.
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 | |
---|---|---|---|---|---|---|---|
ATM ID | atmId | S | 1-100 | C:Conditional | The ATM ID that get from the result of ATM_LIST_INQUIRY and NEARBY_ATM_INQUIRY interface. | ||
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 | M:Mandatory | The name of the city for an ATM location. | ||
Bank Name | bankName | S | 1-100 | M:Mandatory | The owner of the ATM. | ||
Address | address | S | 1-500 | M:Mandatory | The address of an ATM | ||
Longitude | longitude | S | 1-100 | O:Optional | “+30” | Longitude of the ATM's location. | |
Latitude | latitude | S | 1-100 | O:Optional | “-120” | Latitude of the ATM's location. | |
Report Reason | reportReason | N | 1 | M:Mandatory | "0" | This provides the error of ATM information, including the following values:“0”: "There is no ATM at this address"“1”: "The ATM belongs to the wrong bank or city"“2”: "The address description of ATM is not accurate"“3”: "The ATM belongs to the wrong bank or city"“4”: "ChipCard not supported"“5”: “There is a new ATM at this address”“6”: “Others” | |
Other Reason | otherReason | S | 1-100 | O:Optional | 0 | This provides other error of ATM information. |
Filed name | Identifier | Type | Length | Request | Default value | Note | |||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Message Response | msgResponse | Object | M:Mandatory | ||||||||||||||||||||||||||||
|
Field name | Identifier | Type | Length | Request | Default value | Note | |
---|---|---|---|---|---|---|---|
Longitude | longitude | ANS | 1-100 | M:Mandatory | “+30” | Longitude of the user's location. | |
Latitude | latitude | ANS | 1-100 | M:Mandatory | “-120” | Latitude of the user's location. | |
Distance Unit | distanceUnit | A | 1-4 | M:Mandatory | “mile” | The unit for the radius.The combination of "distanceUnit" and “radius” shall be no more than 5miles. Valid Values:• “mile”• “km” | |
Radius | radius | ANS | 1-4 | O:Optional | “2.11” | The radius from the search point.The combination of "distanceUnit" and “radius” shall be no more than 5miles.The value shall only include (numeric) digits "0" to "9" and may contain a single "." character as the decimal mark. The maximum decimal digits is 2. | |
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. The value shall be constant value “20”. |
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. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Nearby ATM List | nearbyAtmList | Array | M:Mandatory | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
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 Operation Team