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

Get multi virtual currencies balance

Request

Gets information about multi virtual currencies and shards balance.

Security
Bearer
Path
merchantIdstringrequired

Merchant ID of the client

projectIdstringrequired

Project ID of the project

curl -i -X GET \
  'https://xsolla.redocly.app/_mock/api/metaframe/v2/merchants/{merchantId}/projects/{projectId}/multicurrency-balance' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Values of multi virtual crrencies balances.

Bodyapplication/json
itemsArray of objects(Balances)

List of multicurrency balances.

Example: [{"balance":14,"image_url":"https://imgurl.com","name":"Blue Orb Point","points":{"base":240,"point":80},"shards":2,"virtual_currency_sku":"xxxxx"}]
Response
application/json
{
  "items": [
    { … }
  ]
}

Topup user's multicurrency balance

Request

Top up user multicurrency balance.

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 topup.

Example: 22
user_idstring(UUID)non-emptyrequired

Xsolla Account ID.

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

Multicurrency SKU

Example: "sapphire_point"
curl -i -X POST \
  'https://xsolla.redocly.app/_mock/api/metaframe/v2/merchants/{merchantId}/projects/{projectId}/multicurrency-balance-topup' \
  -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": "sapphire_point"
  }'

Responses

Operation successful

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

Retrieve info about automatic purchase

Request

Retrieve information about automatic purchase.

Security
Server
Path
merchantIdstringrequired

Merchant ID of the client

projectIdstringrequired

Project ID of the project

userIdstring(UUID)= 36 charactersrequired

Unique User ID.

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

Unique operator ID.

curl -i -X GET \
  'https://xsolla.redocly.app/_mock/api/metaframe/v2/merchants/{merchantId}/projects/{projectId}/user/{userId}/auto-topup' \
  -H 'X-HOST-ID: stringstringstringstringstringstring' \
  -H 'X-SERVER-AUTHORIZATION: YOUR_API_KEY_HERE'

Responses

Information about automatic purchase.

Bodyapplication/json
itemsArray of objects(Item)
Example: [{"enabled":false,"virtual_currency_sku":"xxx-xxx-xxx"}]
Response
application/json
{
  "items": [
    { … }
  ]
}

Update info about automatic purchase

Request

Updates information about automatic purchase.

Security
Server
Path
merchantIdstringrequired

Merchant ID of the client

projectIdstringrequired

Project ID of the project

userIdstring(UUID)= 36 charactersrequired

Unique User ID.

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

Unique operator ID.

Bodyapplication/json
itemsArray of objects(Item)
Example: [{"enabled":false,"virtual_currency_sku":"xxx-xxx-xxx"}]
curl -i -X PUT \
  'https://xsolla.redocly.app/_mock/api/metaframe/v2/merchants/{merchantId}/projects/{projectId}/user/{userId}/auto-topup' \
  -H 'Content-Type: application/json' \
  -H 'X-HOST-ID: stringstringstringstringstringstring' \
  -H 'X-SERVER-AUTHORIZATION: YOUR_API_KEY_HERE' \
  -d '{
    "items": [
      {
        "enabled": false,
        "virtual_currency_sku": "xxx-xxx-xxx"
      }
    ]
  }'

Responses

Information about automatic purchase.

Bodyapplication/json
itemsArray of objects(Item)
Example: [{"enabled":false,"virtual_currency_sku":"xxx-xxx-xxx"}]
Response
application/json
{
  "items": [
    { … }
  ]
}

Charge

Operations

Package

Operations

Manual purchase

Operations