Saltar para o conteúdo
/
Criar pedido com todos os...

Catalog API (2.0.0)

Overview

  • Version: 2.0.0
  • Servers: https://store.xsolla.com/api
  • Contact Us by Email
  • Contact URL: https://xsolla.com/
  • Required TLS version: 1.2

The Catalog API allows you to configure a catalog of in-game items on the Xsolla side and display the catalog to users in your store.

The API allows you to manage the following catalog entities:

  • Virtual items — in-game items such as weapons, skins, boosters.
  • Virtual currency — virtual money used to purchase virtual goods.
  • Virtual currency packages — predefined bundles of virtual currency.
  • Bundles — combined packages of virtual items, currency, or game keys sold as a single SKU.
  • Game keys — keys for games and DLCs distributed via platforms like Steam or other DRM providers.
  • Groups — logical groupings for organizing and sorting items within the catalog.

API calls

The API is divided into the following groups:

  • Admin — calls for creating, updating, deleting, and configuring catalog items and groups. Authenticated via basic access authentication with your merchant or project credentials. Not intended for storefront use.
  • Catalog — calls for retrieving items and building custom storefronts for end users. Designed to handle high-load scenarios. Support optional user JWT authorization to return personalized data such as user-specific limits and active promotions.

Authentication

API calls require authentication either on behalf of a user or on behalf of a project. The authentication scheme used is specified in the Security section in the description of each call.

Authentication using user's JWT

User's JWT authentication is used when a request is sent from a browser, mobile application, or game. By default, the XsollaLoginUserJWT scheme is applied. For details on how to create a token, see the Xsolla Login API documentation.

The token is passed in the Authorization header in the following format: Authorization: Bearer <user_JWT>, where <user_JWT> is the user token. The token identifies the user and provides access to personalized data. You can try this call using the following test token:

eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE5NjIyMzQwNDgsImlzcyI6Imh0dHBzOi8vbG9naW4ueHNvbGxhLmNvbSIsImlhdCI6MTU2MjE0NzY0OCwidXNlcm5hbWUiOiJ4c29sbGEiLCJ4c29sbGFfbG9naW5fYWNjZXNzX2tleSI6IjA2SWF2ZHpDeEVHbm5aMTlpLUc5TmMxVWFfTWFZOXhTR3ZEVEY4OFE3RnMiLCJzdWIiOiJkMzQyZGFkMi05ZDU5LTExZTktYTM4NC00MjAxMGFhODAwM2YiLCJlbWFpbCI6InN1cHBvcnRAeHNvbGxhLmNvbSIsInR5cGUiOiJ4c29sbGFfbG9naW4iLCJ4c29sbGFfbG9naW5fcHJvamVjdF9pZCI6ImU2ZGZhYWM2LTc4YTgtMTFlOS05MjQ0LTQyMDEwYWE4MDAwNCIsInB1Ymxpc2hlcl9pZCI6MTU5MjR9.GCrW42OguZbLZTaoixCZgAeNLGH2xCeJHxl8u8Xn2aI

Alternatively, you can use a token for opening the payment UI.

Basic HTTP authentication

Basic HTTP authentication is used for server-to-server interactions, when an API call is sent directly from your server rather than from a user's browser or mobile application. HTTP Basic authentication with an API key is typically used.

Note

The API key is confidential and must not be stored or used in client applications.

With basic server-side authentication, all API requests must include the following header:

  • for basicAuth — Authorization: Basic <your_authorization_basic_key>, where your_authorization_basic_key is the project_id:api_key pair encoded in Base64
  • for basicMerchantAuth — Authorization: Basic <your_authorization_basic_key>, where your_authorization_basic_key is the merchant_id:api_key pair encoded in Base64

You can find the parameter values in Publisher Account:

  • merchant_id is displayed:
    • In Company settings > Company.
    • In the URL in the browser address bar on any Publisher Account page. The URL has the following format: https://publisher.xsolla.com/<merchant_id>.
  • project_id is displayed:
    • Next to the project name in Publisher Account.
    • In the URL in the browser address bar when working on a project in Publisher Account. The URL has the following format: https://publisher.xsolla.com/<merchant_id>/projects/<project_id>.
  • api_key is shown in Publisher Account only at the time of creation and must be stored securely on your side. You can create an API key in the following sections:
Notice

If a required API call doesn't include the project_id path parameter, use an API key that is valid across all company projects for authorization.

For more information about working with API keys, see the API references.

Authentication with guest access support

The AuthForCart authentication scheme is used for cart purchases and supports two modes:

  1. Authentication with a user's JWT. The token is passed in the Authorization header in the following format: Authorization: Bearer <user_JWT>, where <user_JWT> is the user token. The token identifies the user and provides access to personalized data. You can try this call using the following test token:
eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE5NjIyMzQwNDgsImlzcyI6Imh0dHBzOi8vbG9naW4ueHNvbGxhLmNvbSIsImlhdCI6MTU2MjE0NzY0OCwidXNlcm5hbWUiOiJ4c29sbGEiLCJ4c29sbGFfbG9naW5fYWNjZXNzX2tleSI6IjA2SWF2ZHpDeEVHbm5aMTlpLUc5TmMxVWFfTWFZOXhTR3ZEVEY4OFE3RnMiLCJzdWIiOiJkMzQyZGFkMi05ZDU5LTExZTktYTM4NC00MjAxMGFhODAwM2YiLCJlbWFpbCI6InN1cHBvcnRAeHNvbGxhLmNvbSIsInR5cGUiOiJ4c29sbGFfbG9naW4iLCJ4c29sbGFfbG9naW5fcHJvamVjdF9pZCI6ImU2ZGZhYWM2LTc4YTgtMTFlOS05MjQ0LTQyMDEwYWE4MDAwNCIsInB1Ymxpc2hlcl9pZCI6MTU5MjR9.GCrW42OguZbLZTaoixCZgAeNLGH2xCeJHxl8u8Xn2aI

Alternatively, you can use a token for opening the payment UI.

  1. Simplified mode without Authorization header. This mode is used only for unauthorized users and can be applied only for game key sales. Instead of a token, the request must include the following headers:
    • x-unauthorized-id with a request ID
    • x-user with the user's email address encoded in Base64

Core entity structure

Items of all types (virtual items, bundles, virtual currency, and keys) use a similar data structure. Understanding the basic structure simplifies working with the API and helps you navigate the documentation more easily.

Note

Some calls may include additional fields but they don't change the basic structure.

Identification

  • merchant_id — company ID in Publisher Account
  • project_id — project ID in Publisher Account
  • sku — item SKU, unique within the project

Store display

  • name — item name
  • description — item description
  • image_url — image URL
  • is_enabled — item availability
  • is_show_in_store — whether the item is displayed in the catalog

For more information about managing item availability in the catalog, see the documentation.

Organization

  • type — item type, for example, a virtual item (virtual_item) or bundle (bundle)
  • groups — groups the item belongs to
  • order — display order in the catalog

Sale conditions

  • prices — prices in real or virtual currency
  • limits — purchase limits
  • periods — availability periods
  • regions — regional restrictions

Example of core entity structure:

{
  "attributes": [],
  "bundle_type": "virtual_currency_package",
  "content": [
    {
      "description": {
        "en": "Main in-game currency"
      },
      "image_url": "https://.../image.png",
      "name": {
        "en": "Crystals",
        "de": "Kristalle"
      },
      "quantity": 500,
      "sku": "com.xsolla.crystal_2",
      "type": "virtual_currency"
    }
  ],
  "description": {
    "en": "Crystals x500"
  },
  "groups": [],
  "image_url": "https://.../image.png",
  "is_enabled": true,
  "is_free": false,
  "is_show_in_store": true,
  "limits": {
    "per_item": null,
    "per_user": null,
    "recurrent_schedule": null
  },
  "long_description": null,
  "media_list": [],
  "name": {
    "en": "Medium crystal pack"
  },
  "order": 1,
  "periods": [
    {
      "date_from": null,
      "date_until": "2020-08-11T20:00:00+03:00"
    }
  ],
  "prices": [
    {
      "amount": 20,
      "country_iso": "US",
      "currency": "USD",
      "is_default": true,
      "is_enabled": true
    }
  ],
  "regions": [],
  "sku": "com.xsolla.crystal_pack_2",
  "type": "bundle",
  "vc_prices": []
}

Basic purchase flow

The Xsolla API allows you to implement in-game store logic, including retrieving the item catalog, managing the cart, creating orders, and tracking their status. Depending on the integration scenario, API calls are divided into Admin and Catalog subsections, which use different authentication schemes.

The following example shows a basic flow for setting up and operating a store, from item creation to purchase.

Create items and groups (Admin)

Create an item catalog for your store, such as virtual items, bundles, or virtual currency.

Example API calls:

Set up promotions, chains, and limits (Admin)

Configure user acquisition and monetization tools, such as discounts, bonuses, daily rewards, or offer chains.

Example API calls:

Get item information (Client)

Configure item display in your application.

Notice

Do not use API calls from the Admin subsection to build a user catalog. These API calls have rate limits and aren't intended for user traffic.

Example API calls:

Note

By default, catalog API calls return items that are currently available in the store at the time of the request. To retrieve items that are not yet available or are no longer available, include the parameter "show_inactive_time_limited_items": 1 in the catalog request.

Sell items

You can sell items using the following methods:

  • Fast purchase — sell one SKU multiple times.
  • Cart purchase — the user adds items to the cart, removes items, and updates quantities within a single order.

If an item is purchased using virtual currency instead of real money, use the Create order with specified item purchased by virtual currency API call. The payment UI is not required, as the charge is processed when the API call is executed.

For free item purchase, use the Create order with specified free item API call or the Create order with free cart API call. The payment UI is not required — the order is immediately set to the done status.

Fast purchase

Use the client-side API call to create an order with a specified item. The call returns a token used to open the payment UI.

Note

Discount information is available to the user only in the payment UI. Promo codes are not supported.

Cart purchase

Cart setup and purchase can be performed on the client or on the server side.

Set up and purchase a cart on the client

Implement the logic of adding and removing items by yourself. Before calling the API for setting up a cart, you will not have information about which promotions will be applied to the purchase. This means that the total cost and details of the added bonus items will not be known.

Implement the following cart logic:

  1. After the player has filled a cart, use the Fill cart with items API call. The call returns the current information about the selected items (prices before and after discounts, bonus items).
  2. Update the cart contents based on user actions:
Note

To get the current status of the cart, use the Get current user's cart API call.
  1. Use the Create order with all items from current cart API call. The call returns the order ID and payment token. The newly created order is set to new status by default.

Set up and purchase a cart on the server

This setup option may take longer for setting the cart up, since each change to the cart must be accompanied by API calls.

Implement the following cart logic:

  1. After the player has filled a cart, use the Fill cart with items API call. The call returns current information about the selected items (prices before and after discounts, bonus items).
  2. Use the Create order with all items from current cart API call. The call returns the order ID and payment token. The newly created order is set to new status by default.

Open payment UI

Use the returned token to open the payment UI in a new window. Other ways to open the payment UI are described in the documentation.

ActionEndpoint
Open in production environment.https://secure.xsolla.com/paystation4/?token={token}
Open in sandbox mode.https://sandbox-secure.xsolla.com/paystation4/?token={token}
Note

Use sandbox mode during development and testing. Test purchases don't charge real accounts. You can use [test bank cards](/pt/doc/pay-station/references/test-cards).

After the first real payment is made, a strict sandbox payment policy takes effect. A payment in sandbox mode is available only to users specified in Publisher Account > Company settings > Users.

Buying virtual currency and items for real currency is possible only after signing a license agreement with Xsolla. To do this, in Publisher Account, go to Agreements & Taxes > Agreements, complete the agreement form, and wait for confirmation. It may take up to 3 business days to review the agreement.

To enable or disable sandbox mode, change the value of the sandbox parameter in the request for fast purchase and cart purchase. Sandbox mode is off by default.

Possible order statuses:

  • new — order created
  • paid — payment received
  • done — item delivered
  • canceled — order canceled
  • expired — payment expired

Track order status using one of the following methods:

Pagination

API calls that return large sets of records (for example, when building a catalog) return data in pages. Pagination is a mechanism that limits the number of items returned in a single API response and allows you to retrieve subsequent pages sequentially.

Use the following parameters to control the number of returned items:

  • limit — number of items per page
  • offset — index of the first item on the page (numbering starts from 0)
  • has_more — indicates whether another page is available
  • total_items_count — total number of items

Example request:

GET /items?limit=20&offset=40

Response example:

{
  "items": [...],
  "has_more": true,
  "total_items_count": 135
}

It is recommended to send subsequent requests until the response returns has_more = false.

Date and time format

Dates and time values are passed in the ISO 8601 format.

The following are supported:

  • UTC offset
  • null value when there is no time restriction for displaying an item
  • Unix timestamp (in seconds) used in some fields

Format: YYYY-MM-DDTHH:MM:SS±HH:MM

Example: 2026-03-16T10:00:00+03:00

Localization

Xsolla supports localization of user-facing fields such as item name and description. Localized values are passed as an object where the language code is used as the key. The full list of supported languages is available in the documentation.

Supported fields

Localization can be specified for the following parameters:

  • name
  • description
  • long_description

Locale format

The locale key can be specified in one of the following formats:

  • Two-letter language code: en, ru
  • Five-letter language code: en-US, ru-RU, de-DE

Examples

Example with a two-letter language code:

{
  "name": {
    "en": "Starter Pack",
    "ru": "Стартовый набор"
  }
}

Example with a five-letter language code:

{
  "description": {
    "en-US": "Premium bundle",
    "de-DE": "Premium-Paket"
  }
}

Error response format

If an error occurs, the API returns an HTTP status and a JSON response body. The full list of store-related errors is available in the documentation.

Response example:

{
  "errorCode": 1102,
  "errorMessage": "Validation error",
  "statusCode": 422,
  "transactionId": "c9e1a..."
}
  • errorCode — error code.
  • errorMessage — short error description.
  • statusCode — HTTP response status.
  • transactionId — request ID. Returned only in some cases.
  • errorMessageExtended — additional error details, such as request parameters. Returned only in some cases.

Extended response example:

{
  "errorCode": 7001,
  "errorMessage": "Chain not found",
  "errorMessageExtended": {
    "chain_id": "test_chain_id",
    "project_id": "test_project_id",
    "step_number": 2
  },
  "statusCode": 404
}

Common HTTP status codes

  • 400 — invalid request
  • 401 — authentication error
  • 403 — insufficient permissions
  • 404 — resource not found
  • 422 — validation error
  • 429 — rate limit exceeded

Recommendations

  • Handle the HTTP status and the response body together.
  • Use errorCode to process errors related to application logic.
  • Use transactionId to identify requests more quickly when analyzing errors.
Transferir a descrição da OpenAPI
index.json
index.yaml
Idiomas
Servidores
https://store.xsolla.com/api/
Mock server
https://xsolla.redocly.app/_mock/pt/api/catalog/

Admin

Operações

Catálogo

Operações

Pagamento virtual

Operações

Catálogo

Operações

Direito

Operações

Admin

Operações

Admin

Operações

Catálogo

Operações

Carrinho (lado do cliente)

Operações

Carrinho (lado do servidor)

Operações

Pagamento (lado do cliente)

Operações

Criar pedido com todos os itens do carrinho atualClient-side

Pedido

Usado para a integração cliente-servidor. Cria um pedido com todos os itens do carrinho e gera um token de pagamento para ele. O pedido criado obtém o status do pedido new.

O IP do cliente é usado para determinar o país do usuário, que é usado para aplicar a moeda correspondente e os métodos de pagamento disponíveis para o pedido.

Para abrir a interface de pagamento em uma nova janela, use o seguinte link: https://secure.xsolla.com/paystation4/?token={token}, onde {token} é o token recebido.

Para fins de teste, use este URL: https://sandbox-secure.xsolla.com/paystation4/?token={token}.

Aviso

Como esse método usa o IP para determinar o país do usuário e selecionar uma moeda para o pedido, é importante usar esse método apenas do lado do cliente e não do lado do servidor. Usar esse método do lado do servidor pode causar determinação incorreta da moeda e afetar os métodos de pagamento no Pay Station.
Segurança
AuthForCart
Caminho
project_idintegerobrigatório

Project ID. You can find this parameter in your Publisher Account next to the project name and in the browser address bar when working with a project. The URL has the following format: https://publisher.xsolla.com/<merchant_id>/projects/<project_id>.

Exemplo: 44056
Corpoapplication/json
currencystring

Moeda do preço do pedido. Código de moeda de três letras de acordo com a ISO 4217. Consulte a documentação para obter informações detalhadas sobre as moedas suportadas pelo Xsolla.

custom_parametersobject[ 1 .. 200 ] properties

Parâmetros específicos do projeto.

localestring

Idioma de resposta.

sandboxboolean

Cria um pedido no modo sandbox. A opção está disponível para os usuários especificados na lista de usuários da empresa.

Padrão false
settingsobject

As configurações para instalar o processo de pagamento e a interface de pagamento para um usuário.

settings.​payment_methodinteger(Cart-Payment_settings_payment_method)>= 1

ID do método de pagamento. Ele determina a exibição da moeda na interface de pagamento, pois alguns métodos de pagamento suportam apenas determinadas moedas.

settings.​redirect_policyobject(Cart-Payment_redirect_policy)
settings.​redirect_policy.​delayinteger

Atraso após o qual o usuário será redirecionado automaticamente para o URL de retorno.

Exemplo: 0
settings.​redirect_policy.​redirect_button_captionstring

Legendas de botão de redirecionamento traduzidas.

Exemplo: "Text button"
settings.​redirect_policy.​redirect_conditionsstring

Status de pagamento acionando o redirecionamento do usuário para o URL de retorno.

Enum"none""successful""successful_or_canceled""any"
Exemplo: "none"
settings.​redirect_policy.​status_for_manual_redirectionstring

Status do pagamento acionando a exibição de um botão clicando que redireciona o usuário para o URL de retorno.

Enum"none""successful""successful_or_canceled""any"
Exemplo: "none"
settings.​return_urlstring(uri)(Cart-Payment_settings_return_url)<= 1000 characters

Página para redirecionar o usuário para após o pagamento. Parâmetros user_id, foreigninvoice, invoice_id e status serão adicionados automaticamente ao link.

settings.​uiobject(Cart-Payment_settings_ui)

Configurações da interface.

settings.​ui.​currency_formatstring

Defina como code para exibir um código monetário ISO 4217 de três letras na interface de pagamento. O símbolo da moeda é exibido em vez do código monetário de três letras por padrão.

settings.​ui.​desktopobject

Configurações de interface para a versão desktop.

settings.​ui.​desktop.​headerobject

Configurações de cabeçalho.

settings.​ui.​desktop.​header.​close_buttonboolean

Se um botão Fechar na interface de pagamento desktop deve ser exibido ou não. O botão fecha a interface de pagamento e redireciona o usuário para o URL especificado no parâmetro settings.return_url. false por padrão.

Padrão false
settings.​ui.​desktop.​header.​is_visibleboolean

Se o cabeçalho na interface de pagamento deve ser exibido ou não.

settings.​ui.​desktop.​header.​typestring

Como mostrar o cabeçalho. Pode ser compact (oculta o nome do projeto e ID do usuário) ou normal (padrão).

Padrão "normal"
Enum"compact""normal"
settings.​ui.​desktop.​header.​visible_logoboolean

Se true, o logotipo é exibido no cabeçalho. Para fazer upload da imagem, abra seu projeto na Contado Publisher e vá para aseção Pay Station > Configurações.

settings.​ui.​desktop.​header.​visible_nameboolean

Se o nome do projeto deve ser exibido no cabeçalho ou não.

settings.​ui.​desktop.​header.​visible_purchaseboolean

Se a descrição da compra (purchase.description.value) deve ser exibida no cabeçalho ou não. true por padrão.

Padrão true
settings.​ui.​headerobject
settings.​ui.​header.​visible_virtual_currency_balanceboolean

Se esse elemento pode ser ocultado ou não na interface de pagamento.

Padrão true
settings.​ui.​is_cart_open_by_defaultboolean

A exibição da lista de itens no carrinho ao abrir a versão móvel da interface de pagamento. Se true, a lista é exibida na visualização estendida. Se for false (padrão) ou os parâmetros não forem passados, a lista é exibida em uma visualização reduzida.

Padrão false
settings.​ui.​is_independent_windowsboolean

Se os usuários devem ser redirecionados do navegador integrado do inicializador (WebView) ao navegador padrão para fazer uma compra.

Padrão false
settings.​ui.​is_payment_methods_list_modeboolean

Se uma lista dos métodos de pagamento disponíveis no país do usuário deve ser exibida ou não ao abrir a interface de pagamento. Se false (padrão), o método de pagamento passando no parâmetro settings.payment_method ou o método selecionado pelo algoritmo PayRank será exibido.

Padrão false
settings.​ui.​is_prevent_external_link_openboolean

Se o redirecionamento de links a uma fonte externa está desabilitado ou não. Ao clicar em um link externo, o evento external-link-open é enviado através do mecanismo postMessage. O endereço para o link de redirecionamento é passado no parâmetro url.

Padrão false
settings.​ui.​is_show_close_widget_warningboolean

Se deve ser exibido um aviso sobre o processamento da transação ao focalizar o cursor sobre o ícone × antes de fechar a página de pagamento ou não. Se false for passado, ou o parâmetro não for passado, o aviso não será exibido.

Padrão true
settings.​ui.​is_three_ds_independent_windowsboolean

Se a verificação 3-D Secure deve ser aberta em uma nova janela do navegador ou não. Se sua configuração utiliza Content Security Policy (CSP), defina como true.

Padrão false
settings.​ui.​layoutstring

Local dos elementos principais da interface de pagamento. Você pode abrir a interface de pagamento dentro do seu jogo e/ou trocar as colunas com informações sobre um pedido e métodos de pagamento. Consulte as instruções de personalização para mais detalhes.

Enum"embed""column_reverse""embed_column_reverse"
settings.​ui.​mobileobject
settings.​ui.​mobile.​headerobject
settings.​ui.​mobile.​header.​close_buttonboolean

Se um botão Fechar na interface de pagamento móvel deve ser exibido ou não. O botão fecha a interface de pagamento e redireciona o usuário para o URL especificado no parâmetro settings.return_url.

Padrão false
settings.​ui.​modestring

Modo de interface na interface de pagamento. Pode ser apenas user_account. O cabeçalho contém apenas o menu de navegação da conta, e o usuário não pode selecionar um produto ou fazer um pagamento. Esse modo só está disponível no desktop.

Valor"user_account"
settings.​ui.​themestring

Tema da interface de pagamento. Pode ser 63295a9a2e47fab76f7708e1 para o tema claro (padrão) ou 63295aab2e47fab76f7708e3 para o tema escuro. Você também pode criar um tema personalizado e passar seu ID nesse parâmetro.

Padrão "63295a9a2e47fab76f7708e1"
Enum"63295a9a2e47fab76f7708e1""63295aab2e47fab76f7708e3"
settings.​ui.​user_accountobject

Dados da conta do usuário.

settings.​ui.​user_account.​infoobject

Página Minha conta.

settings.​ui.​user_account.​info.​enablebooleanobrigatório

Se o submenu deve ser exibido ou não. false por padrão.

Padrão false
settings.​ui.​user_account.​info.​orderinteger>= 1obrigatório

Posição do submenu no menu.

settings.​ui.​user_account.​payment_accountsobject

Submenu My payment accounts.

settings.​ui.​user_account.​payment_accounts.​enablebooleanobrigatório

Se o submenu deve ser exibido ou não. false por padrão.

Padrão false
settings.​ui.​user_account.​subscriptionsobject

Submenu Manage subscriptions.

settings.​ui.​user_account.​subscriptions.​enablebooleanobrigatório

Se o submenu deve ser exibido ou não. false por padrão.

Padrão false
settings.​ui.​user_account.​subscriptions.​orderinteger>= 1obrigatório

Posição do submenu no menu.

curl -i -X POST \
  https://store.xsolla.com/api/v2/project/44056/payment/cart \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "custom_parameters": {
      "character_id": "ingameUsername"
    },
    "sandbox": true,
    "settings": {
      "ui": {
        "desktop": {
          "header": {
            "close_button": false,
            "is_visible": true,
            "type": "normal",
            "visible_logo": true,
            "visible_name": true,
            "visible_purchase": true
          }
        },
        "theme": "63295a9a2e47fab76f7708e1"
      }
    }
  }'

Respostas

Pedido criada com sucesso.

Corpoapplication/json
order_idinteger

ID de pedido.

tokenstring

Token de pagamento.

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

Criar pedido com todos os itens de um carrinho específicoClient-side

Pedido

Usado para a integração cliente-servidor. Cria um pedido com todos os itens do carrinho em particular e gera um token de pagamento para ele. O pedido criado obtém o status do pedido new.

O IP do cliente é usado para determinar o país do usuário, que é usado para aplicar a moeda correspondente e os métodos de pagamento disponíveis para o pedido.

Para abrir a interface de pagamento em uma nova janela, use o seguinte link: https://secure.xsolla.com/paystation4/?token={token}, onde {token} é o token recebido.

Para fins de teste, use este URL: https://sandbox-secure.xsolla.com/paystation4/?token={token}.

Aviso

Como esse método usa o IP para determinar o país do usuário e selecionar uma moeda para o pedido, é importante usar esse método apenas do lado do cliente e não do lado do servidor. Usar esse método do lado do servidor pode causar determinação incorreta da moeda e afetar os métodos de pagamento no Pay Station.
Segurança
AuthForCart
Caminho
project_idintegerobrigatório

Project ID. You can find this parameter in your Publisher Account next to the project name and in the browser address bar when working with a project. The URL has the following format: https://publisher.xsolla.com/<merchant_id>/projects/<project_id>.

Exemplo: 44056
cart_idstringobrigatório

ID do carrinho.

Exemplo: custom_id
Corpoapplication/json
currencystring

Moeda do preço do pedido. Código de moeda de três letras de acordo com a ISO 4217. Consulte a documentação para obter informações detalhadas sobre as moedas suportadas pelo Xsolla.

custom_parametersobject[ 1 .. 200 ] properties

Parâmetros específicos do projeto.

localestring

Idioma de resposta.

sandboxboolean

Cria um pedido no modo sandbox. A opção está disponível para os usuários especificados na lista de usuários da empresa.

Padrão false
settingsobject

As configurações para instalar o processo de pagamento e a interface de pagamento para um usuário.

settings.​payment_methodinteger(Cart-Payment_settings_payment_method)>= 1

ID do método de pagamento. Ele determina a exibição da moeda na interface de pagamento, pois alguns métodos de pagamento suportam apenas determinadas moedas.

settings.​redirect_policyobject(Cart-Payment_redirect_policy)
settings.​redirect_policy.​delayinteger

Atraso após o qual o usuário será redirecionado automaticamente para o URL de retorno.

Exemplo: 0
settings.​redirect_policy.​redirect_button_captionstring

Legendas de botão de redirecionamento traduzidas.

Exemplo: "Text button"
settings.​redirect_policy.​redirect_conditionsstring

Status de pagamento acionando o redirecionamento do usuário para o URL de retorno.

Enum"none""successful""successful_or_canceled""any"
Exemplo: "none"
settings.​redirect_policy.​status_for_manual_redirectionstring

Status do pagamento acionando a exibição de um botão clicando que redireciona o usuário para o URL de retorno.

Enum"none""successful""successful_or_canceled""any"
Exemplo: "none"
settings.​return_urlstring(uri)(Cart-Payment_settings_return_url)<= 1000 characters

Página para redirecionar o usuário para após o pagamento. Parâmetros user_id, foreigninvoice, invoice_id e status serão adicionados automaticamente ao link.

settings.​uiobject(Cart-Payment_settings_ui)

Configurações da interface.

settings.​ui.​currency_formatstring

Defina como code para exibir um código monetário ISO 4217 de três letras na interface de pagamento. O símbolo da moeda é exibido em vez do código monetário de três letras por padrão.

settings.​ui.​desktopobject

Configurações de interface para a versão desktop.

settings.​ui.​desktop.​headerobject

Configurações de cabeçalho.

settings.​ui.​desktop.​header.​close_buttonboolean

Se um botão Fechar na interface de pagamento desktop deve ser exibido ou não. O botão fecha a interface de pagamento e redireciona o usuário para o URL especificado no parâmetro settings.return_url. false por padrão.

Padrão false
settings.​ui.​desktop.​header.​is_visibleboolean

Se o cabeçalho na interface de pagamento deve ser exibido ou não.

settings.​ui.​desktop.​header.​typestring

Como mostrar o cabeçalho. Pode ser compact (oculta o nome do projeto e ID do usuário) ou normal (padrão).

Padrão "normal"
Enum"compact""normal"
settings.​ui.​desktop.​header.​visible_logoboolean

Se true, o logotipo é exibido no cabeçalho. Para fazer upload da imagem, abra seu projeto na Contado Publisher e vá para aseção Pay Station > Configurações.

settings.​ui.​desktop.​header.​visible_nameboolean

Se o nome do projeto deve ser exibido no cabeçalho ou não.

settings.​ui.​desktop.​header.​visible_purchaseboolean

Se a descrição da compra (purchase.description.value) deve ser exibida no cabeçalho ou não. true por padrão.

Padrão true
settings.​ui.​headerobject
settings.​ui.​header.​visible_virtual_currency_balanceboolean

Se esse elemento pode ser ocultado ou não na interface de pagamento.

Padrão true
settings.​ui.​is_cart_open_by_defaultboolean

A exibição da lista de itens no carrinho ao abrir a versão móvel da interface de pagamento. Se true, a lista é exibida na visualização estendida. Se for false (padrão) ou os parâmetros não forem passados, a lista é exibida em uma visualização reduzida.

Padrão false
settings.​ui.​is_independent_windowsboolean

Se os usuários devem ser redirecionados do navegador integrado do inicializador (WebView) ao navegador padrão para fazer uma compra.

Padrão false
settings.​ui.​is_payment_methods_list_modeboolean

Se uma lista dos métodos de pagamento disponíveis no país do usuário deve ser exibida ou não ao abrir a interface de pagamento. Se false (padrão), o método de pagamento passando no parâmetro settings.payment_method ou o método selecionado pelo algoritmo PayRank será exibido.

Padrão false
settings.​ui.​is_prevent_external_link_openboolean

Se o redirecionamento de links a uma fonte externa está desabilitado ou não. Ao clicar em um link externo, o evento external-link-open é enviado através do mecanismo postMessage. O endereço para o link de redirecionamento é passado no parâmetro url.

Padrão false
settings.​ui.​is_show_close_widget_warningboolean

Se deve ser exibido um aviso sobre o processamento da transação ao focalizar o cursor sobre o ícone × antes de fechar a página de pagamento ou não. Se false for passado, ou o parâmetro não for passado, o aviso não será exibido.

Padrão true
settings.​ui.​is_three_ds_independent_windowsboolean

Se a verificação 3-D Secure deve ser aberta em uma nova janela do navegador ou não. Se sua configuração utiliza Content Security Policy (CSP), defina como true.

Padrão false
settings.​ui.​layoutstring

Local dos elementos principais da interface de pagamento. Você pode abrir a interface de pagamento dentro do seu jogo e/ou trocar as colunas com informações sobre um pedido e métodos de pagamento. Consulte as instruções de personalização para mais detalhes.

Enum"embed""column_reverse""embed_column_reverse"
settings.​ui.​mobileobject
settings.​ui.​mobile.​headerobject
settings.​ui.​mobile.​header.​close_buttonboolean

Se um botão Fechar na interface de pagamento móvel deve ser exibido ou não. O botão fecha a interface de pagamento e redireciona o usuário para o URL especificado no parâmetro settings.return_url.

Padrão false
settings.​ui.​modestring

Modo de interface na interface de pagamento. Pode ser apenas user_account. O cabeçalho contém apenas o menu de navegação da conta, e o usuário não pode selecionar um produto ou fazer um pagamento. Esse modo só está disponível no desktop.

Valor"user_account"
settings.​ui.​themestring

Tema da interface de pagamento. Pode ser 63295a9a2e47fab76f7708e1 para o tema claro (padrão) ou 63295aab2e47fab76f7708e3 para o tema escuro. Você também pode criar um tema personalizado e passar seu ID nesse parâmetro.

Padrão "63295a9a2e47fab76f7708e1"
Enum"63295a9a2e47fab76f7708e1""63295aab2e47fab76f7708e3"
settings.​ui.​user_accountobject

Dados da conta do usuário.

settings.​ui.​user_account.​infoobject

Página Minha conta.

settings.​ui.​user_account.​info.​enablebooleanobrigatório

Se o submenu deve ser exibido ou não. false por padrão.

Padrão false
settings.​ui.​user_account.​info.​orderinteger>= 1obrigatório

Posição do submenu no menu.

settings.​ui.​user_account.​payment_accountsobject

Submenu My payment accounts.

settings.​ui.​user_account.​payment_accounts.​enablebooleanobrigatório

Se o submenu deve ser exibido ou não. false por padrão.

Padrão false
settings.​ui.​user_account.​subscriptionsobject

Submenu Manage subscriptions.

settings.​ui.​user_account.​subscriptions.​enablebooleanobrigatório

Se o submenu deve ser exibido ou não. false por padrão.

Padrão false
settings.​ui.​user_account.​subscriptions.​orderinteger>= 1obrigatório

Posição do submenu no menu.

curl -i -X POST \
  https://store.xsolla.com/api/v2/project/44056/payment/cart/custom_id \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "custom_parameters": {
      "character_id": "ingameUsername"
    },
    "sandbox": true,
    "settings": {
      "ui": {
        "desktop": {
          "header": {
            "close_button": false,
            "is_visible": true,
            "type": "normal",
            "visible_logo": true,
            "visible_name": true,
            "visible_purchase": true
          }
        },
        "theme": "63295a9a2e47fab76f7708e1"
      }
    }
  }'

Respostas

Pedido criada com sucesso.

Corpoapplication/json
order_idinteger

ID de pedido.

tokenstring

Token de pagamento.

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

Criar pedido com item especificadoClient-side

Pedido

Used for client-to-server integration. Creates an order with a specified item and generates a payment token for it. The created order gets the new order status.

The client IP is used to determine the user’s country, which is then used to apply the corresponding currency and available payment methods for the order.

To open the payment UI in a new window, use the following link: https://secure.xsolla.com/paystation4/?token={token}, where {token} is the received token.

For testing purposes, use this URL: https://sandbox-secure.xsolla.com/paystation4/?token={token}.

Notice

As this method uses the IP to determine the user’s country and select a currency for the order, it is important to only use this method from the client side and not from the server side. Using this method from the server side may cause incorrect currency determination and affect payment methods in Pay Station.

Notice

This API call uses a user JWT for authorization.

Include the token in the Authorization header in the following format: Bearer <user_JWT>. For more information about user JWT, see the Security block for this call.
Segurança
XsollaLoginUserJWT
Caminho
project_idintegerobrigatório

Project ID. You can find this parameter in your Publisher Account next to the project name and in the browser address bar when working with a project. The URL has the following format: https://publisher.xsolla.com/<merchant_id>/projects/<project_id>.

Exemplo: 44056
item_skustringobrigatório

SKU do item.

Exemplo: booster_mega_1
Corpoapplication/json
currencystring

Moeda do preço do pedido. Código de moeda de três letras de acordo com a ISO 4217. Consulte a documentação para obter informações detalhadas sobre as moedas suportadas pelo Xsolla.

custom_parametersobject[ 1 .. 200 ] properties

Parâmetros específicos do projeto.

localestring

Idioma de resposta.

promo_codestring

Resgata um código de uma promoção de código promocional com pagamento.

quantityinteger>= 1

Quantidade do item.

Padrão 1
sandboxboolean

Cria um pedido no modo sandbox. A opção está disponível para os usuários especificados na lista de usuários da empresa.

Padrão false
settingsobject

As configurações para instalar o processo de pagamento e a interface de pagamento para um usuário.

settings.​payment_methodinteger(Cart-Payment_settings_payment_method)>= 1

ID do método de pagamento. Ele determina a exibição da moeda na interface de pagamento, pois alguns métodos de pagamento suportam apenas determinadas moedas.

settings.​redirect_policyobject(Cart-Payment_redirect_policy)
settings.​redirect_policy.​delayinteger

Atraso após o qual o usuário será redirecionado automaticamente para o URL de retorno.

Exemplo: 0
settings.​redirect_policy.​redirect_button_captionstring

Legendas de botão de redirecionamento traduzidas.

Exemplo: "Text button"
settings.​redirect_policy.​redirect_conditionsstring

Status de pagamento acionando o redirecionamento do usuário para o URL de retorno.

Enum"none""successful""successful_or_canceled""any"
Exemplo: "none"
settings.​redirect_policy.​status_for_manual_redirectionstring

Status do pagamento acionando a exibição de um botão clicando que redireciona o usuário para o URL de retorno.

Enum"none""successful""successful_or_canceled""any"
Exemplo: "none"
settings.​return_urlstring(uri)(Cart-Payment_settings_return_url)<= 1000 characters

Página para redirecionar o usuário para após o pagamento. Parâmetros user_id, foreigninvoice, invoice_id e status serão adicionados automaticamente ao link.

settings.​uiobject(Cart-Payment_settings_ui)

Configurações da interface.

settings.​ui.​currency_formatstring

Defina como code para exibir um código monetário ISO 4217 de três letras na interface de pagamento. O símbolo da moeda é exibido em vez do código monetário de três letras por padrão.

settings.​ui.​desktopobject

Configurações de interface para a versão desktop.

settings.​ui.​desktop.​headerobject

Configurações de cabeçalho.

settings.​ui.​desktop.​header.​close_buttonboolean

Se um botão Fechar na interface de pagamento desktop deve ser exibido ou não. O botão fecha a interface de pagamento e redireciona o usuário para o URL especificado no parâmetro settings.return_url. false por padrão.

Padrão false
settings.​ui.​desktop.​header.​is_visibleboolean

Se o cabeçalho na interface de pagamento deve ser exibido ou não.

settings.​ui.​desktop.​header.​typestring

Como mostrar o cabeçalho. Pode ser compact (oculta o nome do projeto e ID do usuário) ou normal (padrão).

Padrão "normal"
Enum"compact""normal"
settings.​ui.​desktop.​header.​visible_logoboolean

Se true, o logotipo é exibido no cabeçalho. Para fazer upload da imagem, abra seu projeto na Contado Publisher e vá para aseção Pay Station > Configurações.

settings.​ui.​desktop.​header.​visible_nameboolean

Se o nome do projeto deve ser exibido no cabeçalho ou não.

settings.​ui.​desktop.​header.​visible_purchaseboolean

Se a descrição da compra (purchase.description.value) deve ser exibida no cabeçalho ou não. true por padrão.

Padrão true
settings.​ui.​headerobject
settings.​ui.​header.​visible_virtual_currency_balanceboolean

Se esse elemento pode ser ocultado ou não na interface de pagamento.

Padrão true
settings.​ui.​is_cart_open_by_defaultboolean

A exibição da lista de itens no carrinho ao abrir a versão móvel da interface de pagamento. Se true, a lista é exibida na visualização estendida. Se for false (padrão) ou os parâmetros não forem passados, a lista é exibida em uma visualização reduzida.

Padrão false
settings.​ui.​is_independent_windowsboolean

Se os usuários devem ser redirecionados do navegador integrado do inicializador (WebView) ao navegador padrão para fazer uma compra.

Padrão false
settings.​ui.​is_payment_methods_list_modeboolean

Se uma lista dos métodos de pagamento disponíveis no país do usuário deve ser exibida ou não ao abrir a interface de pagamento. Se false (padrão), o método de pagamento passando no parâmetro settings.payment_method ou o método selecionado pelo algoritmo PayRank será exibido.

Padrão false
settings.​ui.​is_prevent_external_link_openboolean

Se o redirecionamento de links a uma fonte externa está desabilitado ou não. Ao clicar em um link externo, o evento external-link-open é enviado através do mecanismo postMessage. O endereço para o link de redirecionamento é passado no parâmetro url.

Padrão false
settings.​ui.​is_show_close_widget_warningboolean

Se deve ser exibido um aviso sobre o processamento da transação ao focalizar o cursor sobre o ícone × antes de fechar a página de pagamento ou não. Se false for passado, ou o parâmetro não for passado, o aviso não será exibido.

Padrão true
settings.​ui.​is_three_ds_independent_windowsboolean

Se a verificação 3-D Secure deve ser aberta em uma nova janela do navegador ou não. Se sua configuração utiliza Content Security Policy (CSP), defina como true.

Padrão false
settings.​ui.​layoutstring

Local dos elementos principais da interface de pagamento. Você pode abrir a interface de pagamento dentro do seu jogo e/ou trocar as colunas com informações sobre um pedido e métodos de pagamento. Consulte as instruções de personalização para mais detalhes.

Enum"embed""column_reverse""embed_column_reverse"
settings.​ui.​mobileobject
settings.​ui.​mobile.​headerobject
settings.​ui.​mobile.​header.​close_buttonboolean

Se um botão Fechar na interface de pagamento móvel deve ser exibido ou não. O botão fecha a interface de pagamento e redireciona o usuário para o URL especificado no parâmetro settings.return_url.

Padrão false
settings.​ui.​modestring

Modo de interface na interface de pagamento. Pode ser apenas user_account. O cabeçalho contém apenas o menu de navegação da conta, e o usuário não pode selecionar um produto ou fazer um pagamento. Esse modo só está disponível no desktop.

Valor"user_account"
settings.​ui.​themestring

Tema da interface de pagamento. Pode ser 63295a9a2e47fab76f7708e1 para o tema claro (padrão) ou 63295aab2e47fab76f7708e3 para o tema escuro. Você também pode criar um tema personalizado e passar seu ID nesse parâmetro.

Padrão "63295a9a2e47fab76f7708e1"
Enum"63295a9a2e47fab76f7708e1""63295aab2e47fab76f7708e3"
settings.​ui.​user_accountobject

Dados da conta do usuário.

settings.​ui.​user_account.​infoobject

Página Minha conta.

settings.​ui.​user_account.​info.​enablebooleanobrigatório

Se o submenu deve ser exibido ou não. false por padrão.

Padrão false
settings.​ui.​user_account.​info.​orderinteger>= 1obrigatório

Posição do submenu no menu.

settings.​ui.​user_account.​payment_accountsobject

Submenu My payment accounts.

settings.​ui.​user_account.​payment_accounts.​enablebooleanobrigatório

Se o submenu deve ser exibido ou não. false por padrão.

Padrão false
settings.​ui.​user_account.​subscriptionsobject

Submenu Manage subscriptions.

settings.​ui.​user_account.​subscriptions.​enablebooleanobrigatório

Se o submenu deve ser exibido ou não. false por padrão.

Padrão false
settings.​ui.​user_account.​subscriptions.​orderinteger>= 1obrigatório

Posição do submenu no menu.

curl -i -X POST \
  https://store.xsolla.com/api/v2/project/44056/payment/item/booster_mega_1 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "custom_parameters": {
      "character_id": "ingameUsername"
    },
    "promo_code": "discount_code",
    "quantity": 5,
    "sandbox": true,
    "settings": {
      "ui": {
        "desktop": {
          "header": {
            "close_button": false,
            "is_visible": true,
            "type": "normal",
            "visible_logo": true,
            "visible_name": true,
            "visible_purchase": true
          }
        },
        "theme": "63295a9a2e47fab76f7708e1"
      }
    }
  }'

Respostas

Pedido criada com sucesso.

Corpoapplication/json
order_idinteger

ID de pedido.

tokenstring

Token de pagamento.

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

Pagamento (lado do servidor)

Operações

Pedido

Operações

Itens gratuitos

Operações

Gestão

Operações

Admin

Operações

Reservas

Operações

Comerciante

Operações

Catálogo

Esta API permite obter qualquer tipo de itens vendáveis ou itens específicos.

Operações

Regiões comuns

Operações

Admin

Operações

Admin

Operações

Catálogo

Operações