Saltar para o conteúdo
/
Obtém contas salvas

Pay Station API (2.0)

Visão geral

  • 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
index.json
index.yaml
Idiomas
Servidores
https://api.xsolla.com/merchant/v2/
Mock server
https://xsolla.redocly.app/_mock/pt/api/pay-station/

Token

Operações

Tokenização

Operações

Obtém contas salvas

Pedido

Lista contas de pagamento salvas de um usuário específico.

Observe

No modo sandbox, essa chamada de API só funciona com cartões de teste que não tenham a função 3-D Secure.

Segurança
basicAuth
Caminho
project_idintegerobrigatório

ID do projeto.

user_idstringobrigatório

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).

Consulta
modestring

Defina como sandbox para testar o processo de pagamento. Remova o parâmetro para fazer pagamentos reais.

curl -i -X GET \
  -u <username>:<password> \
  'https://api.xsolla.com/merchant/v2/projects/{project_id}/users/{user_id}/payment_accounts?mode=string'

Respostas

OK.

Corpoapplication/json
Resposta
application/json
[
  {
    "id": 4612345,
    "name": "PP_saved_account",
    "payment_system": { … },
    "type": "paypal"
  }
]

Excluir conta salva

Pedido

Exclui uma conta de pagamento salva.

Observe

No modo sandbox, essa chamada de API só funciona com cartões de teste que não tenham a função 3-D Secure.

Observe

Você pode chamar esse método API no modo sandbox. Para fazer isso, passe os dados da conta de pagamento de teste na solicitação. Consulte as instruções para mais detalhes sobre o acesso no modo sandbox e os cenários de teste.

Segurança
basicAuth
Caminho
project_idintegerobrigatório

ID do projeto.

user_idstringobrigatório

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).

typestringobrigatório

Tipo de conta de pagamento.

Enum ValorDescrição
alipayplus_boost

Boost.

alipayplus_cn

Alipay.

alipayplus_dana

DANA.

alipayplus_gcash

GCash.

alipayplus_hk

Alipay (Hong Kong).

alipayplus_kplus

K PLUS.

alipayplus_maya

Maya.

alipayplus_rabbitlinepay

Rabbit LINE pay.

alipayplus_tng

Touch 'n Go.

alipayplus_truemoney

TrueMoney Wallet.

account_idintegerobrigatório

ID de uma conta salva no banco de dados da Xsolla.

curl -i -X DELETE \
  -u <username>:<password> \
  'https://api.xsolla.com/merchant/v2/projects/{project_id}/users/{user_id}/payment_accounts/{type}/{account_id}'

Respostas

No Content.

Cobrar com conta salva

Pedido

Cobra um usuário através de uma conta de pagamento salva.

Observe

No modo sandbox, essa chamada de API só funciona com cartões de teste que não tenham a função 3-D Secure.

Aviso

Para a chamada de API funcionar corretamente, configure um tempo limite de 2 minutos.

Segurança
basicAuth
Caminho
project_idintegerobrigatório

ID do projeto.

user_idstringobrigatório

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).

typestringobrigatório

Tipo de conta de pagamento.

Enum ValorDescrição
alipayplus_boost

Boost.

alipayplus_cn

Alipay.

alipayplus_dana

DANA.

alipayplus_gcash

GCash.

alipayplus_hk

Alipay (Hong Kong).

alipayplus_kplus

K PLUS.

alipayplus_maya

Maya.

alipayplus_rabbitlinepay

Rabbit LINE pay.

alipayplus_tng

Touch 'n Go.

alipayplus_truemoney

TrueMoney Wallet.

account_idintegerobrigatório

ID de uma conta salva no banco de dados da Xsolla.

Corpoapplication/jsonobrigatório
custom_parametersobject(custom_parameters)

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.

custom_parameters.​active_datestring

Última data de visualização, de acordo com o ISO 8601.

custom_parameters.​additional_verificationboolean

Se o jogador utiliza procedimentos de verificação de conta ou não.

custom_parameters.​character_customizedboolean

Se o jogador personalizou seu personagem ou não.

custom_parameters.​chat_activityboolean

Se o jogador utiliza a função de chat ou não.

custom_parameters.​completed_tasksinteger

Quantidade de tarefas/objetivos concluídos.

custom_parameters.​forum_activityboolean

Se o jogador utiliza a função do fórum ou não.

custom_parameters.​items_usedboolean

Se o jogador usa itens de jogo comprados ou não.

custom_parameters.​karma_pointsinteger

Karma do jogador.

custom_parameters.​last_change_password_datestring

Data da última alteração de senha, de acordo com o ISO 8601.

custom_parameters.​non_premium_currencynumber(float)

Quantidade de moedas não Premium.

custom_parameters.​notifications_enabledboolean

Se o jogador habilitou notificações ou não.

custom_parameters.​profile_completedboolean

Se o jogador adicionou informações adicionais ao seu perfil ou não.

custom_parameters.​profile_image_addedboolean

Se o jogador enviou uma imagem de perfil nova ou não.

custom_parameters.​pvp_activityboolean

Se o jogador participa de batalhas PvP (Jogador vs jogador).

custom_parameters.​registration_datestring

Data de criação da conta, de acordo com o ISO 8601.

custom_parameters.​session_timestring

Tempo de sessão médio, de acordo com o ISO 8601.

custom_parameters.​social_networks_addedboolean

Se o jogador conectou seus perfis de mídias sociais ou não.

custom_parameters.​total_bansinteger

Quantidade de vezes que o jogador foi banido do chat/fórum.

custom_parameters.​total_charactersinteger

Quantidade de personagens no jogo.

custom_parameters.​total_clansinteger

Quantidade de clãs dos quais o jogador fez parte.

custom_parameters.​total_friendsinteger

Quantidade de amigos.

custom_parameters.​total_game_eventsinteger

Quantidade de eventos no jogo dos quais o jogador participou.

custom_parameters.​total_giftsinteger

Quantidade de presentes no jogo que o jogador enviou/recebeu.

custom_parameters.​total_hoursinteger

Tempo total de horas no jogo.

custom_parameters.​total_inventory_valuenumber(float)

Valor total do inventário (moeda do jogo).

custom_parameters.​total_sumnumber(float)

Quantia total de pagamentos.

custom_parameters.​tutorial_completedboolean

Se o jogador concluiu o tutorial do jogo ou não.

custom_parameters.​unlocked_achievementsinteger

Quantidade de conquistas desbloqueadas.

custom_parameters.​user_levelinteger

Nível, reputação ou classificação do jogador.

custom_parameters.​win_rateinteger

Taxa de vitórias.

purchaseobject

Objeto que contém dados de compra.

purchase.​checkoutobject

Objeto que contém dados de pagamento.

purchase.​checkout.​amountnumber(float)

Quantia de compra.

purchase.​checkout.​currencystring

Moeda da compra. Código da moeda de três letras de acordo com o ISO 4217.

purchase.​descriptionobject
purchase.​description.​valuestring<= 4000 characters
purchase.​virtual_currencyobject

Objeto que contém dados da moeda virtual.

purchase.​virtual_currency.​quantitynumber(float)

Quantia da compra em moedas virtuais.

settingsobject

Objeto que contém configurações de compra.

settings.​currencystring(currency)

Moeda de compra preferencial. Código da moeda de três letras de acordo com o ISO 4217.

settings.​external_idstring(external_id)

ID da transação no jogo. Deve ser único para cada pagamento. Confira a documentação para obter mais detalhes.

settings.​mock_codeinteger(mock_code)

Um código de erro que você deseja reproduzir ao testar o processo de pagamento via PayPal no modo sandbox. Ele só funciona corretamente se você passar o parâmetro "mode":"sandbox".

Enum1002101510391046105710891201120318011803
settings.​modestring

Defina como sandbox para testar o processo de pagamento. Remova o parâmetro para realizar pagamentos reais.

userobject

Dados do usuário.

user.​ipstringobrigatório

Endereço IP do usuário.

user.​legalobject(legal)

Objeto com dados da entidade legal.

user.​legal.​addressstring

Endereço legal completo.

user.​legal.​countrystring

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.

user.​legal.​namestring

Nome legal completo.

user.​legal.​vat_idstring

Identificação de contribuinte individual.

user.​namestring

Nome de usuário.

curl -i -X POST \
  -u <username>:<password> \
  'https://api.xsolla.com/merchant/v2/projects/{project_id}/users/{user_id}/payments/{type}/{account_id}' \
  -H 'Content-Type: application/json' \
  -d '{
    "purchase": {
      "description": {
        "value": "currency purchase"
      },
      "virtual_currency": {
        "quantity": 100
      }
    },
    "settings": {
      "currency": "USD",
      "external_id": "ext123",
      "mode": "sandbox"
    },
    "user": {
      "ip": "111.11.11.11",
      "legal": {
        "address": "17 Crown Street London SW2 0JW United Kingdom",
        "country": "GB",
        "name": "My Awesome Company",
        "vat_id": "GB111111111"
      },
      "name": "John Smith"
    }
  }'

Respostas

Created.

Corpoapplication/json
transaction_idinteger
Resposta
application/json
{
  "transaction_id": 123458390
}

Relatórios

Operações

Reembolso

Operações

Testes

Operações