1. Communication Protocol

💡

All API calls must comply with the following rules:

Type	Description
TLS Version	To ensure transaction security, use HTTPS with TLS version 1.2 or above. See TLS Upgrade Notes for details.
Method	POST
Content-Type	application/json
Character Encoding	UTF-8
Signature Algorithm	SHA256
Signature Requirement	See APIs Signature for detailed instructions.

Processed Logic	Evaluate in the following order: protocol-level response → business-level response → transaction status.

2. Message Structure

HTTP Request

HTTP Response

resultCode only indicates whether the request was processed successfully; it does not reflect the business document status (e.g., payment or refund result).
To determine the actual transaction result, refer to the Webhook callback message or the status field in the query API response.

For order status descriptions, see Order Status

For error code details, see APIs error code

3. APIs Gateway URL

📌

We only provide production environments — all functionalities can be verified directly in production.

Region	API URL
North America/South America	https://apis.bkpays.com/gateway/base/biz
Asia/Mid East/Europe/Africa	https://api.bkpays.com/gateway/base/biz

4 OMS Management Dashboard URL

Region	Dashboard URL
North America/South America	https://latin.bkpays.com/login
Asia/Mid East/Europe/Africa	https://asia.bkpays.com/login

5 Interface Parameter Rules

Required	Description
M	Mandatory
O	Optional
C	Conditional (Mandatory under specific conditions)

API Request Structure Definition

1. Communication Protocol#

2. Message Structure#

3. APIs Gateway URL#

4 OMS Management Dashboard URL#

5 Interface Parameter Rules#

1. Communication Protocol

2. Message Structure

3. APIs Gateway URL

4 OMS Management Dashboard URL

5 Interface Parameter Rules