Open API >Information Service >Response Message Inquiry
Response Message Inquiry
Information Service Acquirer Issuer
Query the corresponding interpretation through the system response code
API Introduction
API Introduction
Key Features

Self service troubleshooting

When to Use it?

When developers or organizations want to know the corresponding meaning of the response code, they can get it through the API interface

At present, the response code of GSCS can be provided, and the response code of other relevant systems will be increased.


Who Use it?
UPI members who issue UnionPay Card and Acquirer、merchants.
Where to Use it?
This API is available globally
Flow Chart
Flow Chart

流程图.png

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.


API Reference
API Reference
  • RESPONSE_MESSAGE_INQUIRY
Interface description
The interface provides the English and Chinese response message of the inquired response code.
Request Method
HTTP POST
Request Parameter
Field name Identifier Type Length Request Default value Note
Response Code responseCode AN 2 M:Mandatory The inquired response code. Please refer to the list of response code in Technical Specifications on Bankcard Interoperability Part VI for the valid values.
Synchronous Response parameters
Filed name Identifier Type Length Request Default value Note
Message Response msgResponse Object M:Mandatory
Response Code responseCode AN 2 M:Mandatory It contains a code that defines the response to a request.
Response Message responseMsg S 1-100 M:Mandatory It contains the request result and the rejection reason if the request fails. The value of this field can be displayed by the Gateway to notify the user of the request outcome.
Error Details “errorDetail” S 1-255 O:Optional It contains additional detail regarding the problem identified in the message. The information is only for debug purpose. It shall not be displayed to the user.
Response Code responseCode AN 2 R:Returned The inquired response code. Please refer to the list of response code in Technical Specifications on Bankcard Interoperability Part VI for the valid values.
Response Message responseMsg S 1-100 M:Mandatory The English response message of the inquired response code.
Chinese Response Message cnResponseMsg S 1-100 M:Mandatory The Chinese response message of the inquired response code.
  • Contact Us
  • If you have any further questions, please register and submit order in your user center.