Saltar para o conteúdo

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

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://xsolla.redocly.app/_mock/pt/api/pay-station/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" } ]

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://xsolla.redocly.app/_mock/pt/api/pay-station/projects/{project_id}/users/{user_id}/payment_accounts/{type}/{account_id}'

Respostas

No Content.

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.

purchaseobject

Objeto que contém dados de compra.

settingsobject

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

userobject

Dados do usuário.

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