Xsolla-logo

Criar pedido com item especificadoClient-side

post/v2/project/{project_id}/payment/item/{item_sku}

Usado para a integração cliente-servidor. Cria um pedido com um item especificado 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.
SecurityXsollaLoginUserJWT
Request
path Parameters
project_id
required
integer

ID do projeto. Você pode encontrar esse parâmetro em sua Conta de Distribuidor ao lado do nome do projeto.

Example: 44056
item_sku
required
string

Item SKU.

Example: booster_mega_1
Request Body schema: application/json
currency
string

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_parameters
object [ 1 .. 200 ] properties

Parâmetros específicos do projeto.

locale
string

Idioma de resposta.

promo_code
string

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

quantity
integer >= 1
Default: 1

Quantidade do item.

sandbox
boolean
Default: false

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

object

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

payment_method
integer >= 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.

object
delay
integer

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

redirect_button_caption
string

Legendas de botão de redirecionamento traduzidas.

redirect_conditions
string

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

Enum: "none" "successful" "successful_or_canceled" "any"
status_for_manual_redirection
string

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

Enum: "none" "vc" "successful" "successful_or_canceled" "any"
return_url
string <uri> <= 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.

object

Configurações da interface.

currency_format
string

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.

object

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

object

Configurações de cabeçalho.

close_button
boolean
Default: false

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.

is_visible
boolean

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

type
string
Default: "normal"

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

Enum: "compact" "normal"
visible_logo
boolean

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.

visible_name
boolean

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

visible_purchase
boolean
Default: true

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

object
visible_virtual_currency_balance
boolean
Default: true

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

is_cart_open_by_default
boolean
Default: false

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.

is_independent_windows
boolean
Default: false

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

is_payment_methods_list_mode
boolean
Default: false

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.

is_prevent_external_link_open
boolean
Default: false

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.

is_show_close_widget_warning
boolean
Default: true

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.

is_three_ds_independent_windows
boolean
Default: false

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.

layout
string

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"
object
object
close_button
boolean
Default: false

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.

mode
string

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.

Value: "user_account"
theme
string
Default: "63295a9a2e47fab76f7708e1"

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.

Enum: "63295a9a2e47fab76f7708e1" "63295aab2e47fab76f7708e3"
object

Dados da conta do usuário.

object

Página Minha conta.

enable
required
boolean
Default: false

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

order
required
integer >= 1

Posição do submenu no menu.

object

Submenu My payment accounts.

enable
required
boolean
Default: false

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

object

Submenu Manage subscriptions.

enable
required
boolean
Default: false

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

order
required
integer >= 1

Posição do submenu no menu.

Responses
200

Pedido criada com sucesso.

404

Item ou cupom não encontrado. Verifique se os dados usados estão corretos.

422

Erro inválido.

Request samples
application/json
{
  • "custom_parameters": {
    },
  • "promo_code": "discount_code",
  • "quantity": 5,
  • "sandbox": true,
  • "settings": {
    }
}
Response samples
application/json
{
  • "order_id": 641,
  • "token": "f4puMEFFDZcx9nv5HoNHIkPe9qghvBQo"
}