Saltar para o conteúdo

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

Token

Operações

Criar token

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
Caminho
merchant_idintegerobrigatório

ID de comerciante.

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.

purchaseobject(purchase)

Objeto que contém dados de compra.

settingsobject(settings)

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

userobject(user)

Dados do usuário.

curl -i -X POST \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/pt/api/pay-station/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"
      }
    }
  }'

Respostas

Created.

Corpoapplication/json
tokenstring
Resposta
application/json
{
  "token": "eop57k1boA7nnYPtewZ6KEXJyJADEwRT"
}

Tokenização

Operações

Relatórios

Operações

Reembolso

Operações

Testes

Operações