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

List virtual transactions

GET

https://api.eu-west-1.aworld.cloud/app/v1/virtualTransactions

VirtualTransactions

Retrieves a paginated list of virtual transactions for the authenticated user.

Request Example

Shell

JavaScript

Java

Swift

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

Response Example

{
    "items": [
        {
            "virtualTransactionId": "string",
            "userId": "string",
            "virtualCurrencyId": "string",
            "amount": 0,
            "direction": "CREDIT",
            "state": "PENDING",
            "initiator": "string",
            "initiatorType": "USER",
            "counterpart": "string",
            "counterpartType": "USER",
            "redemptionMode": "AUTO",
            "virtualTransactionGroupId": "string",
            "redemptionGroupId": "string",
            "createdAt": "2019-08-24T14:15:22Z",
            "updatedAt": "2019-08-24T14:15:22Z",
            "redeemedAt": "2019-08-24T14:15:22Z",
            "expiresAt": "2019-08-24T14:15:22Z"
        }
    ],
    "nextToken": "string"
}

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Query Params

nextToken

string

optional

Pagination cursor for fetching the next set of results.

limit

integer

optional

Maximum number of virtual transactions to return per page.

Default:

Responses

🟢200OK

application/json

List of virtual transactions retrieved successfully.

Body

items

array[object (VirtualTransaction) {17}]

optional

A list of virtual transactions.

virtualTransactionId

string

required

Unique identifier for the virtual transaction.

userId

string

optional

The ID of the User to whom this transaction pertains.

virtualCurrencyId

string

required

Identifier of the virtual currency involved in the transaction.

amount

number

required

The amount of virtual currency transacted. Positive for credit, negative for debit (direction field also indicates actual movement).

direction

enum<string>

required

Indicates whether the transaction is a credit or a debit for the user.

Allowed values:

CREDITDEBIT

state

enum<string>

required

The current state of the transaction. Expired transactions are evaluated lazily and their state is updated when trying to redeem them.

Allowed values:

PENDINGCOMPLETEDEXPIREDREJECTED

initiator

string

required

Identifier of the entity that initiated the transaction (e.g., userId, ruleId, system process name).

initiatorType

enum<string>

required

The type of entity that initiated the transaction.

Allowed values:

USERREWARD_RULESYSTEMADMIN

counterpart

string

required

Identifier of the counterpart in the transaction (e.g., another userId, system entity).

counterpartType

enum<string>

required

The type of counterpart entity.

Allowed values:

USERSYSTEM

redemptionMode

enum<string>

required

Defines wether the transaction is automatically redeemed or not. If redemptionMode is MANUAL, the transaction will be pending until this transaction (if at credit) or the counterpart transaction (if at debit) is redeemed.

Allowed values:

AUTOMANUAL

virtualTransactionGroupId

string

required

Identifier for a group of related transactions that was processed (created) together ad a database transaction.

redemptionGroupId

string

optional

Identifier for a grouping related transactions (credit and debit counterparts) where redemptionMode was MANUAL. When the credit ledger transaction is redeemed, all transactions in the group are redeemed together.

createdAt

string <date-time>

required

Timestamp when the transaction record was created.

updatedAt

string <date-time>

required

Timestamp when the transaction record was last updated.

redeemedAt

string <date-time>

optional

Timestamp when the transaction was redeemed (ex, state changed to COMPLETED).

expiresAt

string <date-time>

optional

Optional Timestamp that reflects the expiration date of the transaction when redemptionMode is MANUAL and state is PENDING. If not provided, the transaction will never expire.

nextToken

string

optional

Pagination cursor for the next set of results. Null if no more items are available.

🟠401Unauthorized

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

Get virtual balance

Create virtual transactions