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.

Redeem virtual transaction

POST

https://api.eu-west-1.aworld.cloud/app/v1/virtual-transactions/{virtualTransactionId}/redeem

Redeems a virtual transaction, typically converting virtual currency to real-world benefits or rewards.
This endpoint finalizes the redemption process for eligible transactions.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Path Params

Responses

🟢200OK

application/json

Virtual transaction redeemed successfully

Body

🟠400Bad Request

🟠401Unauthorized

🟠404Record Not Found

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.eu-west-1.aworld.cloud/app/v1/virtual-transactions//redeem' \
--header 'Authorization: Bearer <token>'

Response Example

{
    "transactions": [
        {
            "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": null,
                "property2": null
            },
            "amount": 0,
            "expiresAt": "2019-08-24T14:15:22Z",
            "redeemedAt": "string",
            "accountId": "stringstri",
            "workspaceId": "stringstri",
            "sourceRegion": "us-east-1",
            "createdAt": "2019-08-24T14:15:22Z",
            "updatedAt": "2019-08-24T14:15:22Z"
        }
    ]
}

Modified at 2025-10-14 14:40:02

Get virtual transaction by ID