Перейти к содержимому
/
Get multi virtual currenc...

Metaverse Orbs API (1.0.0)

Metaverse Orbs API

Скачать описание OpenAPI
index.json
index.yaml
Языки
Серверы
Mock server
https://xsolla.redocly.app/_mock/ru/api/metaframe/
http://orbs.babka.com/

MultiCurrencies

Операции

Get multi virtual currencies balance

Запрос

Gets information about multi virtual currencies and shards balance.

Безопасность
Bearer
Путь
merchantIdstringобязательный

Merchant ID of the client

projectIdstringобязательный

Project ID of the project

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

Ответы

Values of multi virtual crrencies balances.

Телоapplication/json
itemsArray of objects(Balances)

List of multicurrency balances.

Пример: [{"balance":14,"image_url":"https://imgurl.com","name":"Blue Orb Point","points":{"base":240,"point":80},"shards":2,"virtual_currency_sku":"xxxxx"}]
Ответ
application/json
{
  "items": [
    { … }
  ]
}

Topup user's multicurrency balance

Запрос

Top up user multicurrency balance.

Безопасность
Server
Путь
merchantIdstringобязательный

Merchant ID of the client

projectIdstringобязательный

Project ID of the project

Заголовки
X-OPERATION-IDstring(UUID)= 36 charactersобязательный

Unique operation ID.

X-HOST-IDstring(UUID)= 36 charactersобязательный

Unique operator ID.

Телоapplication/json
shardsinteger(int64)>= 1обязательный

Number of Shards to topup.

Пример: 22
user_idstring(UUID)non-emptyобязательный

Xsolla Account ID.

Пример: "b8fa3003-2448-49fb-bbe2-7f72f420e350"
virtual_currency_skustringnon-emptyобязательный

Multicurrency SKU

Пример: "sapphire_point"
curl -i -X POST \
  'https://xsolla.redocly.app/_mock/ru/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"
  }'

Ответы

Operation successful

Телоapplication/json
balanceobject
Пример: {"balance":1,"shards":5}
Ответ
application/json
{
  "balance": {
    "balance": 1,
    "shards": 5
  }
}

Retrieve info about automatic purchase

Запрос

Retrieve information about automatic purchase.

Безопасность
Server
Путь
merchantIdstringобязательный

Merchant ID of the client

projectIdstringобязательный

Project ID of the project

userIdstring(UUID)= 36 charactersобязательный

Unique User ID.

Заголовки
X-HOST-IDstring(UUID)= 36 charactersобязательный

Unique operator ID.

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

Ответы

Information about automatic purchase.

Телоapplication/json
itemsArray of objects(Item)
Пример: [{"enabled":false,"virtual_currency_sku":"xxx-xxx-xxx"}]
Ответ
application/json
{
  "items": [
    { … }
  ]
}

Update info about automatic purchase

Запрос

Updates information about automatic purchase.

Безопасность
Server
Путь
merchantIdstringобязательный

Merchant ID of the client

projectIdstringобязательный

Project ID of the project

userIdstring(UUID)= 36 charactersобязательный

Unique User ID.

Заголовки
X-HOST-IDstring(UUID)= 36 charactersобязательный

Unique operator ID.

Телоapplication/json
itemsArray of objects(Item)
Пример: [{"enabled":false,"virtual_currency_sku":"xxx-xxx-xxx"}]
curl -i -X PUT \
  'https://xsolla.redocly.app/_mock/ru/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"
      }
    ]
  }'

Ответы

Information about automatic purchase.

Телоapplication/json
itemsArray of objects(Item)
Пример: [{"enabled":false,"virtual_currency_sku":"xxx-xxx-xxx"}]
Ответ
application/json
{
  "items": [
    { … }
  ]
}

Charge

Операции

Package

Операции

Manual purchase

Операции