Open API >Data Service >UnionPay ATM Locator
UnionPay ATM Locator
Data Service Developer Acquirer
UnionPay ATM network has extended to 152 countries and regions. Users can locate such information on ATMs accepting UnionPay cards as detailed address, corresponding bank or institution by means of specific nation or region.
API Introduction
API Introduction
What is it?

UnionPay ATM network has extended to 152 countries and regions. Users can locate such information on overseas ATMs accepting UnionPay cards as detailed address, corresponding bank or institution by means of specific nation or region.

Key Features

Accurate Data Source.

Who Use it?
The system developers of the application provider, system developers of UnionPay International, and system testing and business acceptance personnel.
Where to Use it?
This API is available globally
Flow Chart
Flow Chart


API Document
API Document
  • Get ATM country data
  • Get ATM institution / bank data
  • Query ATM list data according to the parameters
Interface description
Get data from the country drop-down list in the ATM Search Criteria.
Request Method
HTTP POST
Request Parameter
Field name Identifier Type Length Request Default value Note
User ID of Application appID string 128 M-Must
Encryption Key appKey string 128 M-Must
Language lang string 5 M-Must Chinese ‘cn’, English ‘en’, Korean ‘kr’, Japanese ‘jp’, Traditional Chinese ‘hk’, Russian ‘ru’, Thai ‘th’
interface ID procType string 128 M-Must getAtmCountry
Synchronous Response parameters
Filed name Identifier Type Length Request Default value Note
Response Code respCode string 96 M-Must
Response Message respMsg string 96 M-Must
Country Name country string 100 M-Must
Country ID countryId string 100 M-Must
Sample code
Request code
Other
{
 "appId": "liuliangjigou",
 "appKey": "liuliangjigoukey",
 "fields": {
  "lang": "cn"
 },
 "procType": "getAtmCountry"
}

Note: Request message plaintext shall be encrypted by using Key Store file in Sandbox Testing Parameters. The format of encrypted request message would be {"data":"XXXX","signature":"XXXX"}


Encrypted version of above message:

{"data":"eyJhcHBJZCI6ImxpdWxpYW5namlnb3UiLCJwcm9jVHlwZSI6ImdldEF0bUNvdW50cnkiLCJmaWVs\r\nZHMiOnsibGFuZyI6ImNuIn0sImFwcEtleSI6ImxpdWxpYW5namlnb3VrZXkifQ==","signature":"PLP9feozUHocJ2Y+tRbe7RujutWXGjd1YSm4OZju+pEDnjJzgWjpjWczG5fNvZ2goTnBm6lEsyrW\r\n9KmXShtAiZVHtxVRieRRMc2ORWCaqEHUgMFeHoEs7XXBM/c6vamcN6iRDVNwDg4rI+Lv5ZYT4iO8\r\nKdG+2xs2IvDnDNJoE3k="}

Response code
Other
{
 "respCode":"01",
 "respMsg":"success",
 "data":[{
  "country":"韩国",
  "countryId":"1006045" 
 }]
}


Response Code Reference
Response Code Reference
Response code Description
10000 success
10001 sys_error
10002 service_stop
10003 precess_timeout
10004 signature error
20001 Missing necessary parameters
20002 Request parameter format error
20003 Request parameter type error
20004 other error
20005 illegal parameter
20006 Query no record
Steps to Launch
Steps to Launch

Interface Access Flow

1, The caller uses the private key to encrypt the request, while the request message should include caller's user identity information.

2, The caller raises access application.

3, The service provider decrypts the request message using the public key .

4, The service provider updates the interface white list.

5, The service provider generates the key pair.

6, The service provider keeps the private key, and provides the api user the public key and user ID (appID). 

Interface Call Flow

1, The caller uses the public key to encrypt the request, while the request message should include caller's user identity information.

2, The service provider verifies the caller's user identity and the corresponding interface permissions.

3, The service provider decrypts the request message using the private key.

4, The service provider implements the interface function to obtain the return data.

5, The service provider uses private key to encrypt the return message.


FAQ and Documentation
FAQ and Documentation
Documents:
  • Contact Us
  • If you have any further questions, please register and submit order in your user center.