API Description

API Reference

API Description

Merchants integrating with PayCools services must follow the communication protocols, message structures, and signature specifications outlined below to ensure secure and reliable transactions.

1

Communication Protocol

Type	Description
Transport	HTTPS is required for all transactions with TLS version 1.2 or higher. See TLS upgrade notes for details
Method	POST
Data Format	Both request and response data use application/json format
Character Encoding	UTF-8
Signature Algorithm	SHA256WithRSA
Signature Requirement	Both requests and responses must be verified by signature. For details, see Configuration & Signature
Evaluation Logic	Check protocol fields first, then business response, and finally transaction status

2

Message Structure

Unified API Request Parameters

Parameter	Required	Type	Description
appId	Yes	string	Merchant APP ID provided by the platform
sign	Yes	string	RSA signature of param
param	Yes	string	Request parameters as a string

Request Example

{
    "appId": "123456",
    "sign": "abcdef",
    "param": "{}"
}

HTTP Response

{
  "code": 10000,
  "message": "Success",
  "data": "<business_data_json>"
}

Request Instructions

1. appId is a fixed value provided by the platform
2. Construct the request parameters according to the specific API documentation, format them as JSON, and use the result as the value of param
3. Sign the param with your RSA private key and use the resulting value as sign

3

API Endpoints

Test Environmenthttps://globalapi-dev.paycools.com:8902/

Production Environmenthttps://openapi.paycools.com/