1. Obtaining Merchant Number and Secret Key

Search on the Dashboard

2. API Signature

2.1 Signature Algorithm

Type	Description
Algorithm	SHA512

2.3 HTTP Header Standard Signature Parameters Required for All Order Requests

General Header Parameter Description (The following parameters are placed in the http header)

Parameter	Name	Type	Required	Example
serviceName	Fix value	String	M	api.pay
mchId	Merchant Number; Search on the Dashboard	String	M	2020423200001
signType	Signature Type	String	M	SHA512
timestamp	Timestamp (seconds)	String	M	1713110548
sign	Signature String	String	M

2.4 Sign Signature Rules

Use the SHA512 signature algorithm to sign the Signature string.

Signature string rule: mchId + serviceName + method + timestamp + signType + data + key

mchId, serviceName, method, timestamp, signType are the HTTP Header parameters.

data is the payload data from the API order request, i.e., the JSON order parameters.

key is the merchant secret key assigned after successful KYB.

2.5 Signature Example

Request Body

Response Body

Actual Signature

POST /gateway/base/biz HTTP/1.1
method: pay
signType: SHA512
serviceName: api.pay
mchId: 1416010331032883233
timestamp: 1631671670
sign: 9d7bb11c4faf54523b24bd65fa9e104e0b926e7e7932b5c99ba4b1d017f5aed8b5190bedb6b149f745ff768a2faaee78485207943004d2575380d3e3cc00c718
Content-Type: application/json

{
"amount": "5.00",
"callbackUrl": "http://127.0.0.1:8082/callback",
"redirectUrl":"http://www.baidu.com",
"currency": "BRL",
"dynamic": "1",
"email": "muazpe@gmail.com",
"firstname": "Murilo Azeredo Pereira",
"lastname": "your lasttname",
"mchOrderId": "1232434323233463411fv34",
"phone": "+5511967164793",
"docNumber": "14868845802",
"docType": "CPF",
"productinfo": "your pro simple desc"
}

3 API Response Format

API HTTP Response Standard Format

The response data is in JSON format. httpCode 200 indicates a successful request, httpCode 400 indicates a request information error.

Parameter	Name	Type	Required	Example
resultCode	Result Code	String	M	Success: 000000
errorCode	Error Code	String	M	Success: 000000
errorMsg	Error Message	String	O
data	Response Data	Object	O	Returns JSON data
timestamp	Timestamp (seconds)	String	O

HTTP Response Parameter Description (All API responses follow the above format)

2.2 API HTTP Request Notes

Calling Method: HTTPS POST (GET method is not supported). The API is based on HTTPS.

Request and response use JSON data format. Merchant key + SHA512 signature + IP whitelist are used to ensure request data security and network security.

Due to scenarios like active callbacks and automatic callbacks initiated by the system, a single transaction might be called back to the merchant multiple times. Please implement duplicate prevention mechanisms to avoid transaction anomalies.

The production environment requires binding the IP address of the client's server making the order requests; IP binding is not required for redirects.

"+": In the examples, the plus sign indicates string concatenation, not arithmetic addition.

APIs Signature

1. Obtaining Merchant Number and Secret Key#

2. API Signature#

2.1 Signature Algorithm#

2.3 HTTP Header Standard Signature Parameters Required for All Order Requests#

2.4 Sign Signature Rules#

2.5 Signature Example#

3 API Response Format#

API HTTP Response Standard Format#

2.2 API HTTP Request Notes#

1. Obtaining Merchant Number and Secret Key

2. API Signature

2.1 Signature Algorithm

2.3 HTTP Header Standard Signature Parameters Required for All Order Requests

2.4 Sign Signature Rules

2.5 Signature Example

3 API Response Format

API HTTP Response Standard Format

2.2 API HTTP Request Notes