ID de comerciante.
Pay Station API (2.0)
- Versão: 2.0.0
- Servidores:
https://api.xsolla.com/api
Pay Station permite que os parceiros monetizem seus produtos, fornecendo aos usuários uma interface conveniente para pagar compras no jogo na loja. Para configurar a abertura da interface de pagamento, consulte estas istruções.
A Pay Station API fornece os grupos de chamadas a seguir:
- Token — inclui a chamada de API para gerar um token com parâmetros de usuário arbitrários para processar pagamentos adicionais pela interface de pagamento.
- Tokenização — inclui chamadas de API para processar pagamentos com segurança, sem abrir a interface de pagamento ou envolver o usuário.
- Relatórios — inclui chamadas de API para retornar dados sobre transações de usuários, gerar relatórios e obter detalhamento de pagamentos por moeda.
- Reembolso — inclui chamadas de API para solicitar reembolso total e parcial.
- Teste — inclui a chamada de API para testar o processo de estorno.
Você pode encontrar informações detalhadas sobre como configurar a interface de pagamentos no guia de integração da solução Payments.
Observe
Você também pode consultar a seção Xsolla Base API na coleção Postman para testar chamadas de API usadas para integração.
Transferir a descrição da OpenAPI
Idiomas
Servidores
https://api.xsolla.com/merchant/v2/
Mock server
https://xsolla.redocly.app/_mock/pt/api/pay-station/
Pedido
Você pode gerar um token com parâmetros de usuário arbitrários. Esses parâmetros são enviados ao obter o token e retornam no payload após uma transação bem-sucedida. Um token só pode conter parâmetros descritos neste documento ou predefinidos por você.
Se qualquer parâmetro for enviado no formato errado, ou possuir o tipo errado, nenhum token será emitido. Você receberá um código HTTP 422 com a descrição do erro no corpo JSON. Em extended_message, você receberá uma informação com os parâmetros exatos que foram enviados incorretamente.
Por padrão, o tempo de vida do token é de 24 horas. Se quiser alterar esse valor, contate seu Gerente de Sucesso do Cliente ou envie um e-mail para csm@xsolla.com. O novo valor será habilitado para todos os projetos da empresa criados na Conta de Distribuidor.
Aviso
O token obtido após a chamada do método API pode ser usado exclusivamente para autorizar outras solicitações. Este token só pode ser utilizado para abrir a interface de pagamento se você integrar o produto Subscriptions.
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
Esta chamada de API não contém o trajeto-parâmetro project_id, então é preciso usar a chave API que for válida em todos os projetos da empresa para configurar a autorização.
Segurança
basicAuth
Este objeto contém parâmetros para configurar filtros antifraude. A lista de parâmetros é exibida abaixo. Para adicionar parâmetros personalizados, contate seu Gerente de Sucesso do Cliente ou envie um e-mail para csm@xsolla.com.
Última data de visualização, de acordo com o ISO 8601.
Se o jogador utiliza procedimentos de verificação de conta ou não.
Data da última alteração de senha, de acordo com o ISO 8601.
Se o jogador adicionou informações adicionais ao seu perfil ou não.
Data de criação da conta, de acordo com o ISO 8601.
Tempo de sessão médio, de acordo com o ISO 8601.
Se o jogador conectou seus perfis de mídias sociais ou não.
Quantidade de eventos no jogo dos quais o jogador participou.
Objeto que contém dados de compra.
Dados de assinatura.
Planos de assinatura para exibir na interface de pagamento.
Moeda do plano de assinatura a ser utilizado em todos os cálculos.
O tipo de operação aplicado ao plano de assinatura do usuário. Para alterar o plano de assinatura, passe o valor change_plan. Você precisa especificar o novo ID de plano no parâmetro purchase.subscription.plan_id.
ID externo do plano de assinatura. Pode ser encontrado na seção Assinaturas > Planos de assinatura da Conta de Distribuidor.
As configurações para instalar o processo de pagamento e a interface de pagamento para um usuário.
URL da página para o qual o usuário é redirecionado ao fechar a interface de pagamento antes de concluir o pagamento. Só funciona se você usar os objetos settings.ui.desktop.header ou settings.ui.mobile para configurar o botão de fechar a interface de pagamento. Se o botão for configurado, mas o URL não for passado nesse parâmetro, será utilizado o URL passado no parâmetro settings.return_url.
Moeda de compra preferencial. Código da moeda de três letras de acordo com o ISO 4217.
ID da transação no jogo. Deve ser único para cada pagamento. Confira a documentação para obter mais detalhes.
Idioma da interface. Código de idioma de duas letras minúsculas.
Defina como sandbox para testar o processo de pagamento. Nesse caso, use https://sandbox-secure.xsolla.com para acessar a interface de pagamento de testes.
Widget de pagamento. Pode ser paybycash ou giftcard. Se o parâmetro for definido, o usuário é redirecionado ao widget Pay by Cash ou Gift Cards, respectivamente.
Enum"paybycash""giftcard"
ID Xsolla do jogo. Pode ser encontrado na Conta de Distribuidor.
Configurações das políticas de redirecionamento.
Atraso (em segundos) após o qual o usuário é redirecionado automaticamente para o Callback URL.
Comportamento do Pay Station acionado pelo usuário ao clicar no botão fechar ou Voltar ao jogo. Pode ser redirect (por padrão) e postmessage. Se definido como redirect, o usuário é redirecionado ao URL passado no token ou especificado na Conta de Distribuidor. Se for postmessage, o usuário não é redirecionado para outras páginas. Ao clicar no ícone de fechar, o evento close é enviado. Ao clicar no botão Voltar ao jogo, o evento return é enviado.
Enum"redirect""postmessage"
Texto no botão para o redirecionamento manual.
Status de pagamento para o qual um usuário é redirecionado à Callback URL. Pode ser none, successful, successful_or_canсeled, ou any.
Enum"none""successful""successful_or_canceled""any"
Se um temporizador de redirecionamento deve ser exibido na página de status de pagamento ou não. A duração do temporizador é determinada pelo valor passado no parâmetro settings.redirect_policy.delay.
Padrão false
URL da página onde um usuário é redirecionado depois de fazer um pagamento (Callback URL). Consulte a documentação para obter informações mais detalhadas sobre a configuração de redirecionamentos.
Configurações da interface.
Visualização alternativa da tela da interface de pagamento quando aberta. Por exemplo, ela pode exibir métodos de pagamento priorizados.
Quando definido como apple-pay, o usuário vê o botão Apple Pay como a opção de pagamento primária junto de um link à lista de outros métodos de pagamento. Essa lógica não se aplica a dispositivos Android.
Valor"apple-pay"
Se o botão de pagamento rápido via Apple Pay no topo da interface de pagamento deve ser exibido nos dispositivos suportados ou não. true por padrão. Se for false, o Apple Pay é exibido na lista de métodos de pagamento de acordo com o algoritmo PayRank.
Observe
Esse método de pagamento ficará oculto na lista de métodos disponíveis nos dispositivos Android e quaisquer outros dispositivos que não suportem o pagamento com a Apple pay, independentemente do valor do parâmetro.
Configurações do menu.
Configurações do submenu dos planos de assinatura.
Moeda virtual das configurações do submenu.
Se o usuário pode inserir uma quantia arbitrária da moeda virtual na interface de pagamento ou não.
settings.ui.components.virtual_currency.hiddenboolean
Se o submenu deve ser exibido ou não.
Configurações de itens virtuais do submenu.
settings.ui.components.virtual_items.hiddenboolean
Se o submenu deve ser exibido ou não.
Grupo a ser exibido depois de abrir a aba de itens virtuais.
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.
Configurações de interface para a versão desktop.
Configurações de cabeçalho.
Se o botão de fechamento da interface de pagamento deve ser exibido ou não. Quando o usuário o pressiona, a interface de pagamento é fechada e o usuário é redirecionado ao URL passado no parâmetro settings.cancel_url. Se o URL não for passado nesse parâmetro, será utilizado o URL passado no parâmetro settings.return_url.
Padrão false
O ícone do botão Fechar na interface de pagamento.
| Enum Valor | Descrição |
|---|---|
| arrow | O ícone ← à esquerda do cabeçalho da interface de pagamento. |
| cross | O ícone × à direita do cabeçalho da interface de pagamento. |
Se o cabeçalho na interface de pagamento deve ser exibido ou não.
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"
Se true, o logotipo é exibido no cabeçalho. Para enviar a imagem, abra seu projeto na Conta de Distribuidor e acesse a seção Pay Station > Settings.
Se o nome do projeto deve ser exibido no cabeçalho ou não.
Configurações para a lista de planos de assinatura.
Qualquer texto para ser exibido acima da lista de planos de assinatura disponíveis na interface de pagamento.
A maneira como o método de pagamento Google Pay é exibido. Se true, o botão de pagamento rápido via Google Pay é exibido no topo da interface de pagamento, independentemente do dispositivo e navegador do usuário. Se false, o Google Pay é exibido na lista de métodos de pagamento de acordo com o algoritmo PayRank. Se o parâmetro não for passado, o Google Pay é exibido no topo da interface de pagamento de qualquer dispositivo e navegador do usuário, exceto o Safari — no Safari, ele é exibido na lista de métodos de pagamento.
A exibição da lista de itens do carrinho e dados financeiros na interface de pagamento. Se true, a informação é exibida em uma vista estendida. Se false (padrão) ou o parâmetro não for passado, a informação é exibida em uma vista recolhida.
Se os usuários devem ser redirecionados do navegador integrado do inicializador (WebView) ao navegador padrão para fazer uma compra. false por padrão.
settings.ui.is_language_selector_hiddenboolean(is_language_selector_hidden)
Se o seletor de idioma deve estar oculto na página de pagamento ou não. Se false (por padrão), o seletor é exibido.
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.
Se o redirecionamento de links a uma fonte externa está desabilitado ou não. false por padrã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.
settings.ui.is_search_field_hiddenboolean(is_search_field_hidden)
Se uma barra de pesquisa de métodos de pagamento deve ser exibida ou não na interface de pagamento. Se true, a barra de pesquisa será oculta. false por padrão.
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. true por padrão.
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
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"
Se o botão de fechamento da interface de pagamento deve ser exibido na versão móvel ou não. Quando o usuário o pressiona, a interface de pagamento é fechada e o usuário é redirecionado ao URL passado no parâmetro settings.cancel_url. Se o URL não for passado nesse parâmetro, será utilizado o URL passado no parâmetro settings.return_url.
Padrão false
Modo de exibição da interface de pagamento para gerenciar métodos de pagamento salvos. Pode ser definido para user_account ou omitido. Nesse modo, o usuário só pode alterar o idioma, adicionar novos métodos de pagamento e remover os existentes.
Observe
Quando esse parâmetro é passado, o botão de redirecionamento não é exibido. Para redirecionar um usuário depois de salvar um método de pagamento, configure os redirecionamentos automáticos.
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"
Dados da conta do usuário.
Seção Métodos salvos.
Especifica se o ícone do lápis na interface de pagamento que leva à página de edição do método de pagamento deve ser exibido ou não. true por padrão.
Dados do usuário.
Os atributos do usuário por filtrar a lista de itens, representado como um conjunto JSON válido de pares de valores-chave.
Se um usuário pode alterar o país na interface de pagamento. Se country.value for passado no token, o valor será false por padrão.
Código do país de duas letras maiúsculas, de acordo com o ISO 3166-1 alpha-2.
O objeto user.email é uma parte integral para a construção de modelos antifraude e ajuda a aumentar as taxas de aceitação. É um requisito tanto da Xsolla quanto dos sistemas de pagamento. Se o parâmetro não for passado, o campo necessário para inserir o e-mail aparece na página de pagamento. O usuário recebe o recibo da compra no e-mail passado no parâmetro ou no definido na página de pagamento.
Se um usuário pode inserir seu e-mail na inteface de pagamento. Se o parâmetro user.email.value for passado no token, o valor é definido como false por padrão.
E-mail do usuário. Deve ser válido, de acordo com o protocolo RFC 822.
ID de usuário único no jogo armazenado do seu lado. Certifique-se de passar o ID de usuário existente. Em caso de erro, consulte às respostas às Perguntas Frequentes (FAQ).
Objeto com dados da entidade legal. O objeto e todos os seus parâmetros são necessários se user.is_legal for true.
País da incorporação. É utilizado o código de país de duas letras maiúsculas, de acordo com o ISO 3166-1 alpha-2.
Atributos de tráfego.
Canal de tráfego (anúncios contextuais, anúncios de mídia, listas de e-mail, etc.).
- https://api.xsolla.com/merchant/v2/merchants/{merchant_id}/token
- Mock serverhttps://xsolla.redocly.app/_mock/pt/api/pay-station/merchants/{merchant_id}/token
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
-u <username>:<password> \
'https://api.xsolla.com/merchant/v2/merchants/{merchant_id}/token' \
-H 'Content-Type: application/json' \
-d '{
"settings": {
"currency": "USD",
"language": "en",
"project_id": 16184,
"ui": {
"size": "medium"
}
},
"user": {
"email": {
"value": "email@example.com"
},
"id": {
"value": "user_2"
},
"name": {
"value": "John Smith"
}
}
}'Resposta
application/json
{ "token": "eop57k1boA7nnYPtewZ6KEXJyJADEwRT" }
Pedido
Invalida o token de pagamento existente para impedi-lo de ser usado para abrir a interface de pagamento. Use-o para evitar pagamentos duplicados para itens de instância única entre sessões paralelas. Uma vez chamado com sucesso, todas as outras sessões do usuário abertas com esse token de pagamento vão expirar.
Observe
Essa chamada de API é idempotente, e você pode utilizá-la múltiplas vezes.
Segurança
basicAuth
Nenhum corpo de solicitação necessário, mas o cabeçalho Content-Type: application/json deve ser incluso na solicitação. Omiti-lo ou enviar um Content-Type resultará em um erro 415.
- https://api.xsolla.com/merchant/v2/projects/{project_id}/token/{token}/expire
- Mock serverhttps://xsolla.redocly.app/_mock/pt/api/pay-station/projects/{project_id}/token/{token}/expire
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
-u <username>:<password> \
'https://api.xsolla.com/merchant/v2/projects/{project_id}/token/{token}/expire' \
-H 'Content-Type: application/json'Resposta
application/json
{ "status": "expired", "token": "eop57k1boA7nnYPtewZ6KEXJyJADEwRT" }