Integration Access Guide

Request and Response

The API request of the merchant system is submitted to the OTT Pay API server through HTTPS POST method.

The merchant system sends request to the OTT Pay API server, and the OTT Pay API server returns a response after processing the request. Both the request and the response are in JSON format, and the encoding format is UTF-8.

The response result is represented by JSON data format. The status attribute in the response indicates whether it is a successful result, and the result attribute indicates the actual returned data. For example:

{
  "status": "SUCCESS",
  "result": {
    "token": "eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJPTjAwMDAwMTgyMTQiLCJhdWRpZW5jZSI6bnVsbCwicm9sZSI6bnVsbCwiY3JlYXRlZCI6MTY3NzU5NDY2MzM5NywidXNlcnR5cGUiOiJDVVNUT01FUiIsImV4cCI6MTY3NzU5NTU2MywidXNlcmlkIjoxNH0.YHOw2N8oUP3vn_L-euzuUiShDfQbowAjrWjeVef0wn4jgHA4k5zsgcZ6euRUk-R-Xtn2OkYB7R8geGBjQQYnMw",
    "expired": 1677595563672
  }
}

Unsuccessful responses will contain error and message in result, for example:

{
  "status": "ERROR",
  "result": {
    "code": 10003,
    "message": "User does not exist"
  }
}

Error Codes and Corresponding Messages: [API response error code](#api-response error code)

Authorization method

The OTT Pay API server is accessed using JWT token authorization. The merchant system needs to call Authorization API first to obtain a token, which will be included in the request header for each subsequent API call Contains authorization information:

Authorization: Bearer <token>

Example:

Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJPTjAwMDAwMTgyMTQiLCJhdWRpZW5jZSI6bnVsbCwicm9sZSI6bnVsbCwiY3JlYXRlZCI6MTY3NzU5NDY2MzM5NywidXNlcnR5cGUiOiJDVVNUT01FUiIsImV4cCI6MTY3NzU5NTU2MywidXNlcmlkIjoxNH0.YHOw2N8oUP3vn_L-euzuUiShDfQbowAjrWjeVef0wn4jgHA4k5zsgcZ6euRUk-R-Xtn2OkYB7R8geGBjQQYnMw

@

API server URL

Production environment

https://ecom-api.ottpay.com/

Sandbox environment

https://sandbox-api.ottpay.com/

Test cards

All test local card transactions in the sandbox environment must use test cards. The following test cards are provided for testing payment transactions.

Payment Results

When the merchant system calls Payment API, it needs to perform subsequent payment actions according to the returned response results and payment scenarios. Some payment scenarios Payment results cannot be obtained immediately. After the OTT Pay API server receives the payment result from the payment channel, it will send the payment result to the specified callback URL (the callback URL needs to be specified in the request parameter of Payment API, please refer to the specific API description). Of course, the merchant system can also actively query through Payment Status Query API.

API Response error code