Query Available Settlement Quota

Query the remaining CNY settlement quota for a given currency and accumulation method. The response breaks down available quota by accumulation identifier and currency, helping you determine whether sufficient quota exists before initiating a payout.
Request Parameters
quotaAccumulationMethodstring
required
Method used to accumulate CNY settlement.

Valid Values:

USER_ID — WorldFirst account ID.
GLOBAL_ACCOUNT — WorldFirst global account (virtual account).
RECEIVING_ACCOUNT — WorldFirst receiving account.
BENEFICIARY_ID — Unique identifier assigned by WorldFirst when the beneficiary is created.
quotaAccumulationIdstring
required
Accumulation identifier/account number paired with quotaAccumulationMethod. For example, a beneficiary ID or WorldFirst account ID.
Response Parameters
resultResult
See Result.
quotaAccumulationIdstring
Accumulation identifier.
availableQuotasarray
Available quota breakdown, split by accumulation identifier. Maximum 100 elements.
Show child parametersShow child parameters
createdAtdatetime
Timestamp of the quota snapshot. ISO 8601 extended format (e.g., 2026-05-08T14:30:00+08:00).
Error Codes
resultCoderesultStatusresultMessageTroubleshooting
SUCCESSSSuccessN/A
PARAM_ILLEGALFParam illegalRecheck the request and Retry.
Definition
POST /api/open/v1/tradeOrders/queryQuota
Request
{
"quotaAccumulationMethod": "USER_ID",
"quotaAccumulationId": "3097af1e671ef278b6bbba2492d97c0e"
}
Response
{
"result": {
  "resultCode": "SUCCESS",
  "resultMessage": "success",
  "resultStatus": "S"
},
"createdAt": "2026-08-08T14:30:00+08:00",
"quotaAccumulationId": "3097af1e671ef278b6bbba2492d97c0e",
"availableQuotas": [
  {
    "availableQuota": {
      "value": 150000,
      "currency": "CNY"
    }
  }
]
}