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

Tokenização

Operações

Relatórios

Operações

Reembolso

Operações

Solicitar reembolso parcial

Pedido

Envia uma solicitação de reembolso parcial a um usuário. Consulte nossa documentação para obter informações mais detalhadas sobre o processo de reembolso e métodos de pagamento que suportam reembolsos parciais.

Observe

Você pode chamar esse método API no modo sandbox. Para fazer isso, passe os dados 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.

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.

transaction_idintegerobrigatório

ID da transação.

Corpoapplication/jsonobrigatório
descriptionstring<= 4000 charactersobrigatório

Motivo para um reembolso.

refund_amountnumber(float)obrigatório

A quantia do reembolso em uma moeda de compra.

curl -i -X PUT \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/pt/api/pay-station/merchants/{merchant_id}/reports/transactions/{transaction_id}/partial_refund' \
  -H 'Content-Type: application/json' \
  -d '{
    "description": "test refund request",
    "refund_amount": 1.5
  }'

Respostas

Solicitação de reembolso aceita

Resposta
Sem conteúdo

Solicitar reembolso

Pedido

Envia uma solicitação de reembolso para retornar uma parte do pagamento ao usuário. Leia sobre o Recurso de reembolso para saber mais sobre o processo.

Observe

Você pode chamar esse método API no modo sandbox. Para fazer isso, passe os dados 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.

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.

transaction_idintegerobrigatório

ID da transação.

Corpoapplication/jsonobrigatório
descriptionstring<= 4000 charactersobrigatório

Motivo para um reembolso.

emailstring<= 100 characters

E-mail do usuário.

curl -i -X PUT \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/pt/api/pay-station/merchants/{merchant_id}/reports/transactions/{transaction_id}/refund' \
  -H 'Content-Type: application/json' \
  -d '{
    "description": "test refund request"
  }'

Respostas

OK (Sem erro).

Corpoapplication/json
messagestring

Pode retornar uma das seguintes mensagens:

  • No content.
  • The request for a refund has been accepted. Xsolla CS will manually complete the refund. It may take up to two business days.
  • The request for a refund has been accepted. Xsolla CS will automatically send the customer an email with alternative refund options as the user's method does not support direct refunds.
Resposta
application/json
{
  "message": "The request for a refund has been accepted. Xsolla CS will automatically send the customer an email with alternative refund options as the user's method does not support direct refunds."
}

Testes

Operações