Search virtual transactions history

POST

/virtual-transactions/history/search

VirtualTransactions

Search, filter, and sort the current user's virtual transactions using JSONLogic expressions. Supports filtering by virtualCurrencyId, state, direction, initiatorType, and more.

Request

Header Params

Body Params application/json

Examples

Responses

🟢200OK

application/json

Virtual transactions matching search criteria

Bodyapplication/json

🟠401Unauthorized

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://api.aworld.cloud/app/v1/virtual-transactions/history/search' \
--header 'x-external-user-id;' \
--header 'x-user-id;' \
--header 'Content-Type: application/json' \
--data '{
    "filter": {
        "==": [
            {
                "var": "role"
            },
            "admin"
        ]
    },
    "sort": {
        "field": "createdAt",
        "order": "asc"
    },
    "limit": 20,
    "nextToken": "string",
    "fields": [
        "rewardRule"
    ]
}'

Response Example

{
    "items": [
        {
            "userId": "string",
            "virtualCurrencyId": "string",
            "virtualTransactionId": "string",
            "virtualTransactionGroupId": "string",
            "redemptionGroupId": "string",
            "redemptionMode": "AUTO",
            "state": "PENDING",
            "direction": "CREDIT",
            "initiatorType": "USER",
            "initiator": "string",
            "counterpartType": "USER",
            "counterpart": "string",
            "additionalData": {
                "property1": "string",
                "property2": "string"
            },
            "amount": 0,
            "expiresAt": "2019-08-24T14:15:22.123Z",
            "redeemedAt": "string",
            "createdAt": "2019-08-24T14:15:22.123Z",
            "updatedAt": "2019-08-24T14:15:22.123Z",
            "rewardRule": {
                "rewardRuleId": "string",
                "name": "string",
                "version": 0,
                "archived": true
            },
            "sourceEntity": {
                "sourceType": "Activity",
                "sourceId": "string",
                "version": 0,
                "archived": true,
                "title": "string",
                "defaultLang": "en"
            },
            "virtualCurrency": {
                "virtualCurrencyId": "string",
                "name": "string",
                "icon": "string",
                "archived": true,
                "label": "string",
                "defaultLang": "en"
            },
            "streakRule": {
                "streakRuleId": "string",
                "name": "string",
                "version": 0,
                "archived": true,
                "kind": "REGULAR"
            }
        }
    ],
    "nextToken": "eyJwayI6IndvcmtzcGFjZUlkI3pPR0JndVctQWoiLCJxdWl6SWQiOiItRktBdDZfbXM4M3RvSUZaLWVjeFQifQ=="
}

Modified at 2026-06-15 16:41:07

Redeem virtual transaction

Redeem a workspace code