Full Withdrawal

Withdraw all Balance from the Player Account at once.

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

Parameters Before Encryption

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

Encrypted Request Body

{
  "cipherText": "G0ZMDELeJwx+7JcIfIFOLJjkSzANPu6krGM2uw==..."
}

Field	Type	Required	Description
username	string	Yes	Player Account
transId	string	Yes	Transaction ID

Response

Success Response

{
  "code": 0,
  "message": "No error.",
  "data": {
      "amount": 2323.582,
      "balance": 0,
  },
  "logUUID": "06b1c410-c8cb-462b-8fb8-b437c7dc74f0"
}

ResponseFieldDescription

Field	Type	Description
data.amount	number	Withdrawal amount
data.balance	number	Balance after withdrawal

Error Response

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

Common Error Codes

Code	Description
2	Insufficient Balance
3	Transaction Already Exists
8	Player Does Not Exist
11	Parameter Error
19	Invalid Account
20	Player Wallet Temporarily Locked
83	Authentication Failed
84	Decryption Failed

For more error code descriptions, please refer to: Appendix - Error Code Overview

Important Notes

1. Balance Check: If Balance is zero, error code 2 will be returned
2. Transaction ID Uniqueness: Each transId must be unique to prevent duplicate withdrawals
3. Instant Update: After a successful withdrawal, PlayerBalance is immediately updated to 0
4. Idempotency: Repeated submissions using the same transId will return the same result
5. Distinction from Normal Withdrawal:
   • Full Withdrawal: No need to specify an amount; withdraws all Balance

Related API

• Transfer - Partial Withdrawal
• Query PlayerBalance
• Query Transaction Details