Skip to content

Metaverse Orbs API (1.0.0)

Metaverse Orbs API

Download OpenAPI description
index.json
index.yaml
Languages
Servers
Mock server
https://xsolla.redocly.app/_mock/api/metaframe/
http://orbs.babka.com/

MultiCurrencies

Operations

Charge

Operations

Charges Shards from user's balance

Request

Charge shards from user

Security
Server
Path
merchantIdstringrequired

Merchant ID of the client

projectIdstringrequired

Project ID of the project

Headers
X-OPERATION-IDstring(UUID)= 36 charactersrequired

Unique operation ID.

X-HOST-IDstring(UUID)= 36 charactersrequired

Unique operator ID.

Bodyapplication/json
shardsinteger(int64)>= 1required

Number of Shards to charge.

Example: 22
user_tokenstringnon-emptyrequired

Authentication token of the user whose balance is to charge.

virtual_currency_skustringnon-emptyrequired

Multicurrency SKU

Example: "blue_orb_point"
curl -i -X POST \
  'https://xsolla.redocly.app/_mock/api/metaframe/v2/merchants/{merchantId}/projects/{projectId}/multicurrency-charge' \
  -H 'Content-Type: application/json' \
  -H 'X-HOST-ID: stringstringstringstringstringstring' \
  -H 'X-OPERATION-ID: stringstringstringstringstringstring' \
  -H 'X-SERVER-AUTHORIZATION: YOUR_API_KEY_HERE' \
  -d '{
    "shards": 22,
    "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJ....LGH2xCeJHxl8u8Xn2aI=",
    "virtual_currency_sku": "blue_orb_point"
  }'

Responses

Operation successful

Bodyapplication/json
balanceobject
Example: {"orbs":1,"shards":5}
Response
application/json
{
  "balance": {
    "orbs": 1,
    "shards": 5
  }
}

Charges Shards from user's balance by Xsolla Account ID

Request

Charge shards from user by Xsolla Account ID

Security
Server
Path
merchantIdstringrequired

Merchant ID of the client

projectIdstringrequired

Project ID of the project

Headers
X-OPERATION-IDstring(UUID)= 36 charactersrequired

Unique operation ID.

X-HOST-IDstring(UUID)= 36 charactersrequired

Unique operator ID.

Bodyapplication/json
shardsinteger(int64)>= 1required

Number of Shards to charge.

Example: 22
user_idstring(UUID)non-emptyrequired

Xsolla Account ID.

Example: "b8fa3003-2448-49fb-bbe2-7f72f420e350"
virtual_currency_skustringnon-emptyrequired

Multicurrency SKU

Example: "blue_orb_point"
curl -i -X POST \
  'https://xsolla.redocly.app/_mock/api/metaframe/v2/merchants/{merchantId}/projects/{projectId}/multicurrency-charge-user' \
  -H 'Content-Type: application/json' \
  -H 'X-HOST-ID: stringstringstringstringstringstring' \
  -H 'X-OPERATION-ID: stringstringstringstringstringstring' \
  -H 'X-SERVER-AUTHORIZATION: YOUR_API_KEY_HERE' \
  -d '{
    "shards": 22,
    "user_id": "b8fa3003-2448-49fb-bbe2-7f72f420e350",
    "virtual_currency_sku": "blue_orb_point"
  }'

Responses

Operation successful

Bodyapplication/json
balanceobject
Example: {"orbs":1,"shards":5}
Response
application/json
{
  "balance": {
    "orbs": 1,
    "shards": 5
  }
}

Package

Operations

Manual purchase

Operations