Skip to content

Digital Distribution Hub (1.0.0)

Overview

Digital Distribution Hub is a new Xsolla solution that aims to connect digital and cash based payments via push payments technology and e-commerce.

This reference combines API endpoints for two Xsolla products: In-Game Store and Pay Station. There are two base URLs:

  • https://store.xsolla.com/api for the Common, Catalog, Cart, and Order groups.
  • https://ps.xsolla.com for the Notifications group.

API endpoints in the Catalog group don’t require authorization.

To work with operations in the Cart and Order groups, you need to generate a token via Create user token.

Note

This reference shows a design of a future API and not a fully functioning interface. Currently, you can try only Catalog and Notifications groups endpoints. If you’d like to share your feedback, please email us at techdoc@xsolla.com.
Download OpenAPI description
index.json
index.yaml
Languages
Servers
Mock server
https://xsolla.redocly.app/_mock/api/digital-distribution-hub/
https://store.xsolla.com/api/

Cart

Operations

Game keys

Operations

Virtual items & currency

Operations

Get virtual items list

Request

Gets a virtual items list for building a catalog.

Attention. All projects have the limitation to the number of items that you can get in the response. The default and maximum value is 50 items per response. To get more data page by page, use limit and offset fields.
Security
AuthForClient
Path
project_idintegerrequired

Project ID.

Example: 44056
Query
limitinteger

Limit for the number of elements on the page.

Example: limit=50
offsetinteger

Number of the element from which the list is generated (the count starts from 0).

Example: offset=0
localestring

Response language. Two-letter lowercase language code per ISO 639-1.

Default "en"
additional_fields[]Array of strings

The list of additional fields. These fields will be in the response if you send them in your request. Available fields media_list, order, long_description.

countrystring

Country to calculate regional prices and restrictions for catalog. Two-letter uppercase country code per ISO 3166-1 alpha-2. If you do not specify the country explicitly, it will be calculated based on user's IP address.

Default "US"
curl -i -X GET \
  'https://xsolla.redocly.app/_mock/api/digital-distribution-hub/v2/project/44056/items/virtual_items?limit=50&offset=0&locale=en&additional_fields%5B%5D=string&country=US' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

The list of virtual items was successfully received.

Bodyapplication/json
itemsArray of objects(Catalog_inline_response_200_5_items)
Example: [{"sku":"big_rocket","name":"Big Rocket","groups":[{"external_id":"accessory","name":"Accessory"}],"attributes":[{"external_id":"stack_size","name":"Stack size","values":[{"external_id":"size_e3364991f92e751689a68b96598a5a5a84010b85","value":"5"}]}],"type":"virtual_good","description":"Big Rocket - description","image_url":"https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png","is_free":false,"price":{"amount":"100.99","amount_without_discount":"100.99","currency":"USD"},"virtual_prices":[{"amount":100,"sku":"vc_test","is_default":true,"amount_without_discount":100,"image_url":"http://image.png","name":"SHOTGUN FOR TRUE RAIDERS","type":"virtual_currency","description":"description"}],"inventory_options":{"consumable":{"usages_count":1},"expiration_period":{"type":"day","value":1}},"virtual_item_type":"non_renewing_subscription"},{"sku":"shotgun_raider","name":"SHOTGUN FOR TRUE RAIDERS","groups":[{"external_id":"hair","name":"Hair"}],"attributes":[{"external_id":"stack_size","name":"Stack size","values":[{"external_id":"size_e3364991f92e751689a68b96598a5a5a84010b85","value":"5"}]},{"external_id":"rating","name":"Rating","values":[{"external_id":"rating_e3364991f92e751689a68b96598a5a5a84010b85","value":"3.9"}]}],"type":"virtual_good","description":"description","image_url":"http://image.png","is_free":false,"price":{"amount":"101.0","amount_without_discount":"101.0","currency":"USD"},"virtual_prices":[{"amount":100,"sku":"vc_test","is_default":true,"amount_without_discount":100,"image_url":"http://image.png","name":"SHOTGUN FOR TRUE RAIDERS","type":"virtual_currency","description":"description"},{"amount":200,"sku":"vc_test_2","is_default":false,"amount_without_discount":200,"image_url":"http://image.png","name":"SHOTGUN FOR TRUE RAIDERS","type":"virtual_currency","description":"description"}],"inventory_options":{"consumable":{"usages_count":1},"expiration_period":{"type":"day","value":1}},"virtual_item_type":"non_renewing_subscription"},{"sku":"shotgun_raider_2","name":"SHOTGUN FOR TRUE RAIDERS","groups":[],"attributes":[],"type":"virtual_good","description":"description","image_url":"http://image.png","is_free":true,"virtual_prices":[],"inventory_options":{"consumable":{"usages_count":1},"expiration_period":{"type":"day","value":1}},"virtual_item_type":"non_renewing_subscription"}]
Response
application/json
{
  "items": [
    { … },
    { … },
    { … }
  ]
}

Get virtual currency list

Request

Gets a virtual currency list for building a catalog.

Attention. All projects have the limitation to the number of items that you can get in the response. The default and maximum value is 50 items per response. To get more data page by page, use limit and offset fields.
Security
AuthForClient
Path
project_idintegerrequired

Project ID.

Example: 44056
Query
limitinteger

Limit for the number of elements on the page.

Example: limit=50
offsetinteger

Number of the element from which the list is generated (the count starts from 0).

Example: offset=0
localestring

Response language. Two-letter lowercase language code per ISO 639-1.

Default "en"
additional_fields[]Array of strings

The list of additional fields. These fields will be in the response if you send them in your request. Available fields media_list, order, long_description.

countrystring

Country to calculate regional prices and restrictions for catalog. Two-letter uppercase country code per ISO 3166-1 alpha-2. If you do not specify the country explicitly, it will be calculated based on user's IP address.

Default "US"
curl -i -X GET \
  'https://xsolla.redocly.app/_mock/api/digital-distribution-hub/v2/project/44056/items/virtual_currency?limit=50&offset=0&locale=en&additional_fields%5B%5D=string&country=US' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

The list of virtual currency was successfully received.

Bodyapplication/json
itemsArray of objects(Catalog_inline_response_200_6_items)
Example: [{"sku":"big_rocket","name":"Big Rocket","groups":[{"external_id":"accessory","name":"Accessory"}],"attributes":[{"external_id":"stack_size","name":"Stack size","values":[{"value":"5"}]}],"type":"virtual_currency","description":"Big Rocket - short description","image_url":"https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png","is_free":false,"price":{"amount":"100.99","amount_without_discount":"100.99","currency":"USD"},"virtual_prices":[{"amount":100,"sku":"shotgun_raider","is_default":true,"amount_without_discount":100,"image_url":"http://image.png","name":"SHOTGUN FOR TRUE RAIDERS","type":"virtual_currency","description":"description"}],"inventory_options":{"consumable":{"usages_count":1}}},{"sku":"shotgun_raider","name":"SHOTGUN FOR TRUE RAIDERS","groups":[{"external_id":"hair","name":"Hair"}],"attributes":[{"external_id":"stack_size","name":"Stack size","values":[{"value":"1"}]},{"external_id":"rating","name":"Rating","values":[{"value":"3.9"}]},{"external_id":"genre","name":"Genre","values":[{"value":"Strategy"},{"value":"Tactical"},"Turn-based"]}],"type":"virtual_currency","description":"description","image_url":"http://image.png","is_free":false,"price":{"amount":"101.0","amount_without_discount":"101.0","currency":"USD"},"virtual_prices":[],"inventory_options":{"consumable":{"usages_count":1}}},{"sku":"shotgun_raider_2","name":"SHOTGUN FOR TRUE RAIDERS","groups":[],"attributes":[],"type":"virtual_currency","description":"description","image_url":"http://image.png","is_free":true,"virtual_prices":[],"inventory_options":{"consumable":{"usages_count":1}}}]
Response
application/json
{
  "items": [
    { … },
    { … },
    { … }
  ]
}

Get virtual currency package list

Request

Gets a virtual currency packages list for building a catalog.

Attention. All projects have the limitation to the number of items that you can get in the response. The default and maximum value is 50 items per response. To get more data page by page, use limit and offset fields.
Security
AuthForClient
Path
project_idintegerrequired

Project ID.

Example: 44056
Query
limitinteger

Limit for the number of elements on the page.

Example: limit=50
offsetinteger

Number of the element from which the list is generated (the count starts from 0).

Example: offset=0
localestring

Response language. Two-letter lowercase language code per ISO 639-1.

Default "en"
additional_fields[]Array of strings

The list of additional fields. These fields will be in the response if you send them in your request. Available fields media_list, order, long_description.

countrystring

Country to calculate regional prices and restrictions for catalog. Two-letter uppercase country code per ISO 3166-1 alpha-2. If you do not specify the country explicitly, it will be calculated based on user's IP address.

Default "US"
curl -i -X GET \
  'https://xsolla.redocly.app/_mock/api/digital-distribution-hub/v2/project/44056/items/virtual_currency/package?limit=50&offset=0&locale=en&additional_fields%5B%5D=string&country=US' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

The list of virtual currency packages was successfully received.

Bodyapplication/json
itemsArray of objects(Catalog_inline_response_200_7_items)
Example: [{"sku":"vc_package_1","name":"VC Name first package","groups":[],"attributes":[],"type":"bundle","description":"VC Short Package Description","image_url":"http://vc_package_image.png","is_free":false,"price":{"amount":"2.0000","amount_without_discount":"2.0000","currency":"USD"},"bundle_type":"virtual_currency_package","content":[{"description":"Big Rocket - short description","image_url":"https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png","sku":"big_rocket","name":"Big Rocket","type":"virtual_currency","quantity":100,"inventory_options":{"consumable":{"usages_count":1}}}],"virtual_prices":[]},{"sku":"vc_package_3","name":"VC Name third package","groups":[],"attributes":[],"type":"bundle","description":"VC Short Package Description","image_url":"http://vc_package_image.png","is_free":false,"price":{"amount":"4.0000","amount_without_discount":"4.0000","currency":"USD"},"bundle_type":"virtual_currency_package","content":[{"description":"description","image_url":"http://image.png","sku":"shotgun_raider","name":"SHOTGUN FOR TRUE RAIDERS","type":"virtual_currency","quantity":200,"inventory_options":{"consumable":{"usages_count":1}}}],"virtual_prices":[]}]
Response
application/json
{
  "items": [
    { … },
    { … }
  ]
}

Bundles

Operations

User token

Operations

Notifications

Operations

Order

Operations