Docs
Docs
  • 简体中文
  • English
Docs
  • 简体中文
  • English
  • Docs

    • Common Conventions
    • Collection / Payin
    • Payout / Remittance
    • Account Balance
    • Transaction Query
    • Async Notification (Collection / Payout)
    • Signature
    • Account (Acct)
    • Special Instructions

Common Conventions

Current Version

Current version: 1.0.0

Response Format

For all API errors, the HTTP status code is 500.

{
  "code": 506800,
  "message": "Merchant information error"
}

For normal responses:

Single record:

{
  "data": {
    "..."
  }
}

Multiple records (to make it easy to distinguish, the key is list):

{
  "list": [
    {
      "..."
    }
  ]
}

message is returned in English by default. To get Chinese messages, set the header:

"Accept-Language": "zh-CN"

To get English messages, set the header (or leave it unset):

"Accept-Language": "en-US"

Normally, the HTTP status code is 200.

  • This system uses an MD5 signature (see the signature documentation).
  • Request/response content type is application/json.
  • All API requests use POST.
  • Field names are lowercase with underscores.
  • Currency codes are uppercase.
  • Country codes use ISO2 (2 lowercase letters, used to distinguish from currency).
  • Time format: yyyy-MM-dd HH:mm:ss (default timezone: UTC+8).
  • Amounts keep 2 decimal places. Note that .00 may be omitted; pay special attention during signing.
  • Because the system separates hot/cold data, we do not strictly enforce uniqueness of the merchant order number in our system. For correctness, you should still guarantee uniqueness in your own system.

Supported Currencies

CodeDescriptionCountry/Region/Market
USDTTether (USDT)Default for all merchants
CNYChinese Yuancn
PKRPakistan Rupeepk
BDTBangladeshi Takabd
IDRIndonesian Rupiahid
PHPPhilippine Pesoph

Error Codes

CodeMeaning
506413Invalid parameters
506800Invalid merchant ID
506801Merchant key is empty
506802Invalid signature
506803Failed to get channel
506804No channel assigned
506805Duplicate merchant order number
506806Channel fetch failed
506807Invalid channel (format error)
506808Invalid amount
506809Record not found
506810No group information
506811cur must be uppercase
506812Upstream channel exception (maintenance, etc.)
506813Channel cleared by backend (blacklisted merchant, etc.)
506815Upstream channel returned an error
506817Invalid currency type
506818Amount exceeds limit
506900Request IP is not in the configured whitelist
Next
Collection / Payin