Skip to main content

All Cash Out

Withdraw all remaining balances from the member account in a single operation.

API Information​

  • URL：POST /v2/members/cashout
  • Authentication：Bearer Token
  • Encryption：Requests are encrypted using AES-256-GCM; responses are returned as plaintext JSON

request​

request Headers​

POST /v2/members/cashout HTTP/1.1
Host: api.example.com
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
x-agentid: integratorNBTest04
x-timestamp: 1769746894501
x-nonce: 56ffd5ecd8a3a4457863a0bd7c298fb2
x-signature: 904e97bee2589b93e9747eed0346c68b23d8ff8b568dabaf4b94a5e89093df67

Request Parameters​

Request Body Before Encryption​

{
  "username": "player001",
  "transId": "CASHOUT-20250129-001",
}

Encrypted Request Body​

{
  "cipherText": "G0ZMDELeJwx+7JcIfIFOLJjkSzANPu6krGM2uw==..."
}
FieldTypeRequiredDescription
usernamestringYesPlayer Account
transIdstringYesTransaction id

Response​

Success Response​

{
  "code": 0,
  "message": "No error.",
  "data": {
      "amount": 2323.582,
      "balance": 0,
  },
  "logUUID": "06b1c410-c8cb-462b-8fb8-b437c7dc74f0"
}
FieldTypeDescription
data.amountnumberAll amount of transfer out
data.balancenumberPlayer's balance after transaction

Error Response​

{
  "code": 2,
  "message": "The balance is not enough.",
  "logUUID": "6589bf8d-fe74-48bd-841a-71bf8f848f86"
}

Common Error Codes​

CodeDescription
2The balance is not enough.
3The transaction already exist.
8The member does not exist.
11Parameters error
19Invalid account
20Member wallet is temporarily locked, please try again later.
83Authentication Failed
84Decryption Failed

Important Notes​

  1. Balance Check: If the balance is zero, error code 2 will be returned
  2. Transaction ID Uniqueness: Each transId must be unique to prevent duplicate withdrawals
  3. Immediate Update: After a successful withdrawal, the member’s balance is immediately updated to 0
  4. Idempotency: Repeated submissions with the same transId will return the same result
  5. Difference from Regular Withdrawal:
    • All Cash Out: No amount needs to be specified; all remaining balance is withdrawn
    • Regular Withdrawal: A specific amount must be specified