AWorld APIs are in a pre-alpha stage and are being updated frequently. For integration inquiries or technical information, please contact us at server@aworld.org.

AWorld API

Get virtual balance

GET

https://api.eu-west-1.aworld.cloud/app/v1/virtualBalances/{virtualCurrencyId}

VirtualBalances

Retrieves the balance for a specific virtual currency for the authenticated user.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.eu-west-1.aworld.cloud/app/v1/virtualBalances/'

Response Example

{
    "virtualCurrencyId": "string",
    "userId": "string",
    "amount": 0,
    "availableAmount": 0,
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z"
}

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

virtualCurrencyId

string

required

Unique identifier for the virtual currency.

Responses

🟢200OK

application/json

Virtual Balance retrieved successfully.

Body

Virtual Currency Balance representation for client applications, with sensitive data removed

virtualCurrencyId

string

required

The ID of the Virtual Currency to which this balance pertains.

userId

string

required

The ID of the User to whom this balance belongs.

amount

number

required

The total current amount of the virtual currency owned by the user.

availableAmount

number

required

The amount of virtual currency that the user can currently spend. This amount considers any pending debit operations.

createdAt

string <date-time>

required

Timestamp when this virtual balance record was created.

updatedAt

string <date-time>

required

Timestamp when this virtual balance record was last updated.

🟠401Unauthorized

🟠404Record Not Found

Modified at 2025-06-25 15:15:28

List virtual balances

List virtual transactions