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

Package

Operations

Manual purchase

Operations

Create manual purchase

Request

Creates a manual purchase.

Security
Bearer
Path
merchantIdstringrequired

Merchant ID of the client

projectIdstringrequired

Project ID of the project

Headers
X-GEOIP-COUNTRYstring

Determine country based on user's ip

X-IFRAME-HOST-ORIGINstring(uri)

Determine parent payment page

X-HOST-IDstring(UUID)= 36 charactersrequired

Unique operator ID.

Bodyapplication/json
package_item_skustring

Package Item SKU.

Example: "xxx-xxx-xxx"
ps_ui_close_buttonboolean

PayStation 4 UI close button.

ps_ui_localestring

PayStation 4 UI lanugage

Enum"en""de""es""ja""ko""pt""cn""ru"
ps_ui_themestring

PayStation 4 appearance.

Example: "babka_dark"
quantityinteger(int64)>= 1

Number of items.

Example: 1
curl -i -X POST \
  'https://xsolla.redocly.app/_mock/api/metaframe/v2/merchants/{merchantId}/projects/{projectId}/purchase' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -H 'X-GEOIP-COUNTRY: string' \
  -H 'X-HOST-ID: stringstringstringstringstringstring' \
  -H 'X-IFRAME-HOST-ORIGIN: http://example.com' \
  -d '{
    "package_item_sku": "xxx-xxx-xxx",
    "ps_ui_theme": "babka_dark",
    "quantity": 1
  }'

Responses

Operation success

Bodyapplication/json
order_idinteger(uint32)

Order ID.

Example: "641,"
tokenstring

Payment token.

Example: "f4puMEFFDZcx9nv5HoNHIkPe9qghvBQo"
Response
application/json
{
  "order_id": "641,",
  "token": "f4puMEFFDZcx9nv5HoNHIkPe9qghvBQo"
}