ID de comerciante.
Subscriptions API (2.0)
- Versão: 2.0
- Servidores:
https://api.xsolla.com/merchant/v2/
Essa referência API descreve os pontos de extremidade na gerência de assinaturas, cupons e promoções. Para obter mais informações sobre as Assinaturas, veja o guia do produto e o glossário.
Transferir a descrição da OpenAPI
Idiomas
Servidores
Mock server
https://xsolla.redocly.app/_mock/pt/api/subscriptions/
Pedido
Você pode criar um token com parâmetros de usuário arbitrários. Você envia esses parâmetros ao obter o token e os recebe de volta após um pagamento bem-sucedido. Um token só pode conter parâmetros descritos neste documento ou predefinidos por você.
Se algum parâmetro for enviado no formato errado ou tiver 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 sobre quais parâmetros exatos foram enviados incorretamente.
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
Você pode passar parâmetros adicionais no token no objeto custom_parameters para configurar filtros antifraude. Os parâmetros recomendados são exibidos na lista suspensa. Veja a documentação da Estação de Pagamentos.
Última data visto, 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.
Exemplo: {"checkout":{"amount":10,"currency":"USD"},"subscription":{"gift":{"email":"recipient_email@email.com","recipient":"test_recipient_v1"}}}
Objeto que contém dados de pagamento.
Exemplo: {"amount":10,"currency":"USD"}
Moeda da compra. Código da moeda de três letras de acordo com o ISO 4217.
Exemplo: "USD"
Dados de assinatura.
Exemplo: {"gift":{"email":"recipient_email@email.com","recipient":"test_recipient_v1"}}
Planos de assinatura para exibir na interface de pagamento.
Moeda do plano de assinatura a ser utilizado em todos os cálculos.
Informações sobre vale-assinatura.
Exemplo: {"email":"recipient_email@email.com","recipient":"test_recipient_v1"}
Se esconder o nome do remetente. Se true, o nome do remetente ficará oculto na notificação por e-mail. O padrão é false.
E-mail do destinatário.
Exemplo: "recipient_email@email.com"
ID do destinatário.
Exemplo: "test_recipient_v1"
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.
Configurações do projeto personalizadas.
Exemplo: {"currency":"USD","language":"en","project_id":16184,"ui":{"components":{"virtual_currency":{"custom_amount":true}},"desktop":{"virtual_item_list":{"button_with_price":true,"layout":"list"}},"size":"medium"}}
Moeda de compra preferencial. Código da moeda de três letras de acordo com o ISO 4217.
Exemplo: "USD"
ID de transação no jogo. Precisa ser único para cada pagamento de um usuário.
Idioma da interface. Código de idioma de duas letras minúsculas.
Exemplo: "en"
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.
Exemplo: 16184
Configurações das políticas de redirecionamento.
Se o usuário deve ser redirecionado automaticamente da página de status ou não.
Atraso (em segundos) após o qual o usuário é redirecionado automaticamente para o URL de retorno.
Comportamento do Portal de Pagamentos 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 ao URL de retorno. Pode ser none, successful, successful_or_canсeled, ou any.
Enum"none""successful""successful_or_canceled""any"
Página para redirecionar o usuário após um pagamento. Os parâmetros user_id, foreigninvoice, invoice_id e status serão adicionados automaticamente ao link.
Configurações da interface.
Exemplo: {"components":{"virtual_currency":{"custom_amount":true}},"desktop":{"virtual_item_list":{"button_with_price":true,"layout":"list"}},"size":"medium"}
Configurações do menu.
Exemplo: {"virtual_currency":{"custom_amount":true}}
Configurações do submenu dos planos de assinatura.
Moeda virtual das configurações do submenu.
Exemplo: {"custom_amount":true}
Se o usuário pode inserir uma quantia arbitrária da moeda virtual na interface de pagamento ou não.
Exemplo: true
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.
Configurações de interface para a versão desktop.
Exemplo: {"virtual_item_list":{"button_with_price":true,"layout":"list"}}
Configurações de cabeçalho.
Se o botão Fechar no Portal de Pagamentos para o desktop deve ser exibido ou não. O botão fecha o Portal de Pagamentos e redireciona o usuário para o URL especificado no parâmetro settings.return_url. false por padrão.
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 cabeçalho exibirá seu logotipo (primeiro, forneça a imagem do seu Gerente de Sucesso do Cliente).
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.
Se true, se se a moeda local do usuário for diferente da definida no plano de assinatura, o usuário poderá ver ambos preços: um na moeda local, o outro na moeda básica.
Configurações para a lista de moedas virtuais.
Se true, o preço será exibido no botão. Se false, o preço será exibido do lado esquerdo do botão. false por padrão.
Configurações da lista de itens virtuais.
Exemplo: {"button_with_price":true,"layout":"list"}
Se true, o preço será exibido no botão. Se false, o preço será exibido do lado esquerdo do botão. false por padrão.
Exemplo: true
Modelo de lista. Pode ser list (padrão) ou grid.
Enum"list""grid"
Exemplo: "list"
Se os links de redirecionamento a recursos externos podem ou não ser desativados. true 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 redirecionado é passado no parâmetro url.
Modo de interface no Portal de Pagamentos. 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.
Tamanho da interface de pagamento. Pode ser:
- pequeno: o menor tamanho possível para a interface de pagamento. Use esse valor quando o tamanho da janela for consideravelmente limitado (dimensões: 620 x 630)
- médio: o tamanho recomendado. Use esse valor para exibir a interface de pagamento em uma caixa de luz (lightbox) (dimensões: 740 x 760)
- grande: o tamanho ideal para exibir a interface de pagamento em uma nova janela ou aba (dimensões: 820 x 840)
Enum"small""medium""large"
Exemplo: "medium"
Tema da interface de pagamento. Pode ser default ou default_dark.
Enum"default""default_dark"
Dados da conta do usuário.
Submenu Histórico.
Página Minha conta.
Submenu Minhas contas de pagamento.
Dados do usuário.
Exemplo: {"age":19,"country":{"allow_modify":true,"value":"US"},"email":{"value":"john.smith@mail.com"},"id":{"value":"user_2"},"name":{"value":"John Smith"}}
Os atributos do usuário por filtrar a lista de itens, representado como um conjunto JSON válido de pares de valores-chave.
Exemplo: {"allow_modify":true,"value":"US"}
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.
Exemplo: true
Código de país de duas letras maiúsculas, de acordo com o ISO 3166-1 alpha-2.
Exemplo: "US"
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.
Exemplo: {"value":"john.smith@mail.com"}
E-mail do usuário. Deve ser válido, de acordo com o protocolo RFC 822.
Exemplo: "john.smith@mail.com"
Exemplo: {"value":"user_2"}
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.
Exemplo: {"value":"John Smith"}
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/subscriptions/merchants/{merchant_id}/token
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
-u <username>:<password> \
'https://xsolla.redocly.app/_mock/pt/api/subscriptions/merchants/{merchant_id}/token' \
-H 'Content-Type: application/json' \
-d '{
"purchase": {
"checkout": {
"amount": 10,
"currency": "USD"
},
"subscription": {
"gift": {
"email": "recipient_email@email.com",
"recipient": "test_recipient_v1"
}
}
},
"settings": {
"currency": "USD",
"language": "en",
"project_id": 16184,
"ui": {
"components": {
"virtual_currency": {
"custom_amount": true
}
},
"desktop": {
"virtual_item_list": {
"button_with_price": true,
"layout": "list"
}
},
"size": "medium"
}
},
"user": {
"age": 19,
"country": {
"allow_modify": true,
"value": "US"
},
"email": {
"value": "john.smith@mail.com"
},
"id": {
"value": "user_2"
},
"name": {
"value": "John Smith"
}
}
}'Resposta
application/json
{ "token": "eop57k1boA7nnYPtewZ6KEXJyJADEwRT" }