Skip to content

Player Balance Reclaim

The Agent system can call this API to actively reclaim/withdraw all local remaining balances for a player in the VCT platform (e.g. when the player exits the lobby).

Upon calling this API, VCT will clear all local game wallets for the player to 0 and immediately trigger the Balance Reclaim Callback (/settle) to return the final balance to the Agent's system.

Endpoint

PropertyValue
PathPOST /papi/v1/player/reclaim
AuthenticationAgent Token (Bearer)
Content-Typeapplication/x-www-form-urlencoded

Request Parameters

ParameterTypeRequiredDescription
member_idstringYesUnique player ID in the Agent system

Request Example

bash
curl -X POST https://api.example.com/papi/v1/player/reclaim \
  -H "Authorization: Bearer {agent_token}" \
  -d "member_id=player_001"

Response Fields

Data Field Structure

FieldTypeDescription
member_idstringPlayer ID in the Agent system
reclaimed_amountdecimalTotal amount successfully reclaimed and credited back via /settle
currencystringCurrency code (returns an empty string if no active balance exists)

Success Response

  • Successfully Reclaimed Funds (credits back via /settle):
    json
    {
      "status": true,
      "code": 0,
      "data": {
        "member_id": "player_001",
        "reclaimed_amount": 100.00,
        "currency": "MYR"
      },
      "msg": "success"
    }
  • No Funds to Reclaim (local wallet balance is already 0):
    json
    {
      "status": true,
      "code": 0,
      "data": {
        "member_id": "player_001",
        "reclaimed_amount": 0,
        "currency": ""
      },
      "msg": "success"
    }

Failed Response

json
{
  "status": false,
  "code": 7,
  "data": {},
  "msg": "player_not_found"
}

VCT Gaming Integration Platform