Saltar para o conteúdo
/
Obter transação

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

Obter relatórios

Pedido

Obtém a lista de relatórios financeiros ao longo de um período específico.

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.

Consulta
datetime_fromstring(datetime)obrigatório

O início do período no formato AAAA-MM-DD. Não é obrigatório se ao menos um dos seguintes parâmetros for passado:

  • transfer_id
  • report_id

Exemplo: datetime_from=2023-02-08
datetime_tostring(datetime)obrigatório

O fim do período no formato AAAA-MM-DD. Não é obrigatório se ao menos um dos seguintes parâmetros for passado:

  • transfer_id
  • report_id
A diferença entre datetime_from e datetime_to não pode ser maior do que 92 dias.

Exemplo: datetime_to=2023-03-08
curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/pt/api/pay-station/merchants/{merchant_id}/reports?datetime_from=2023-02-08&datetime_to=2023-03-08'

Respostas

OK.

Corpoapplication/json
Resposta
application/json
[
  {
    "agreement_document_id": "Organization Inc_RUB",
    "currency": "RUB",
    "is_direct_payout": false,
    "is_draft_by_agreement": true,
    "month": "January",
    "report_id": 57613,
    "year": 2019
  },
  {
    "agreement_document_id": "Organization Inc_EUR",
    "currency": "USD",
    "is_direct_payout": false,
    "is_draft_by_agreement": true,
    "month": "January",
    "report_id": 57619,
    "year": 2019
  }
]

Obter transações

Pedido

Retorna a lista de informações detalhadas sobre todas as transações bem- sucedidas e canceladas em um período específico. Em resposta, você obtém informações sobre pagamentos, incluindo dados sobre as taxas, tarifas, bem como pedido e usuário. Você pode obter a lista nos formatos JSON e CSV. Você pode usar essa chamada API para realizar a reconciliação financeira.

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.

formatstringobrigatório

Formato da data.

Enum"json""csv""xls"
Consulta
datetime_fromstring(datetime)obrigatório

O início do período no formato AAAA-MM-DD. Não é obrigatório se ao menos um dos seguintes parâmetros for passado:

  • transfer_id
  • report_id

Exemplo: datetime_from=2023-02-08
datetime_tostring(datetime)obrigatório

O fim do período no formato AAAA-MM-DD. Não é obrigatório se ao menos um dos seguintes parâmetros for passado:

  • transfer_id
  • report_id
A diferença entre datetime_from e datetime_to não pode ser maior do que 92 dias.

Exemplo: datetime_to=2023-03-08
in_transfer_currencyintegerobrigatório

Converte todos os dados financeiros à moeda do pagamento (a moeda de pagamento é usada por padrão). Não é obrigatório se ao menos um dos seguintes parâmetros for passado:

  • transfer_id
  • report_id

show_totalboolean

Se a quantia total das transações deve ser incluída ou não no relatório. Disponível para exportar apenas no formato CSV. true por padrão.

merchant_of_recordsstring or null

Comerciante do Registro. Pode ser xsolla, merchant, ou não especificado. Se for merchant, retorna as transações feitas através dos portais do parceiro. Se for xsolla, retorna as transações que não foram feitas pelos portais do parceiro. Se não for especificado, retorna todas as transações.

Enum ValorDescrição
merchant

Retorna as transações feitas pelos portais do parceiro.

xsolla

Retorna as transações que não foram feitas pelos portais do parceiro.

project_idinteger

ID do projeto.

show_dry_runboolean

Se transações de teste devem ser incluídas ou não.

transfer_idinteger

ID de pagamento.

report_idinteger

ID de relatório financeiro.

offsetinteger

Número do elemento a partir do qual a lista é gerada (a quantidade começa a partir de 0).

limitinteger

Limite da quantidade de transações exibidas na página. Se esse parâmetro for passado, você não precisará passar os parâmetros datetime_from e datetime_to.

statusstring

Status da transação.

Enum"done""canceled""error""refunded"
curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/pt/api/pay-station/merchants/{merchant_id}/reports/transactions/registry.{format}?datetime_from=2023-02-08&datetime_to=2023-03-08&in_transfer_currency=0&show_total=true&merchant_of_records=xsolla&project_id=0&show_dry_run=true&transfer_id=0&report_id=0&offset=0&limit=0&status=done'

Respostas

A lista de transações foi retornada com sucesso.

Corpoapplication/jsonArray [
payment_detailsobject

Dados de pagamento.

purchaseobject

Dados da compra.

transactionobject

Dados da transação.

userobject

Dados do usuário.

user_balanceobject

Saldo do usuário.

]
Resposta
application/json
[
  {
    "payment_details": { … },
    "purchase": { … },
    "transaction": { … },
    "user": { … },
    "user_balance": { … }
  }
]

Encontrar transações

Pedido

Retorna uma lista de transações com base nos parâmetros de busca específicos. Em resposta, você obtém dados sobre todos os pagamentos feitos no seu jogo, mesmo que eles não tenham sido concluídos com sucesso. Você pode especificar não só o período de transação como também outros parâmetros. Exemplo: pesquisar por transações feitas por um usuário em particular ou com um status de pagamento específico. Você pode obter a lista no formato JSON ou CSV.

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.

formatstringobrigatório

Formato da data.

Enum"json""csv""xls"
Consulta
datetime_fromstring(datetime)

Início do período.

datetime_tostring(datetime)

Fim do período.

project_idinteger

ID do projeto.

transaction_idinteger

ID da transação.

typestring

Tipos de transações exibidas nos resultados da pesquisa.

Enum ValorDescrição
all

Todas as transações.

canceled

Transações canceladas, excluindo transações de teste.

test

Transações de teste.

transferred

Transações bem-sucedidas, excluindo transações de teste.

phonestring

Número de telefone no formato internacional.

user_idstring

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

user_namestring

Nome de usuário.

user_customstring

Parâmetro personalizado para a identificação do usuário.

emailstring<= 100 characters

E-mail do usuário.

external_idstring

ID de transação no jogo. Precisa ser único para cada pagamento de um usuário.

order_idinteger

ID do Pedido. Você pode usá-lo para chamar o método de API Obter pedido.

Exemplo: order_id=1234
offsetinteger

Número do elemento a partir do qual a lista é gerada (a quantidade começa a partir de 0).

limitinteger

Limite da quantidade de elementos na página.

statusstring(status.enum)

Um status de transação.

Enum ValorDescrição
awaitingRefund

A transação está aguardando a decisão sobre um reembolso. Depois que o usuário solicita um reembolso, o suporte ao cliente Xsolla processa a solicitação manualmente e toma uma decisão sobre o reembolso.

canceled

Há dois cenários possíveis:

  • A transação foi cancelada no lado do sistema de pagamento. Por exemplo, houve fundos insuficientes na conta do usuário.
  • O pagamento foi reembolsado ao usuário.
created

O usuário iniciou a transação mas ela ainda não foi processada.

done

A transação foi processada com sucesso.

error

Ocorreu um erro durante o processamento da transação. Tais pagamentos podem ser reembolsados contatando o suporte ao cliente Xsolla.

partiallyRefunded

O usuário recebeu um reembolso parcial.

processing

A transação está sendo processada.

refunded

Um reembolso foi feito ao saldo Xsolla do usuário.

review

O processamento da transação foi suspenso pelo sistema antifraude e a transação está atualmente sob verificação adicional.

curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/pt/api/pay-station/merchants/{merchant_id}/reports/transactions/search.{format}?datetime_from=string&datetime_to=string&project_id=0&transaction_id=0&type=all&phone=string&user_id=string&user_name=string&user_custom=string&email=string&external_id=string&order_id=1234&offset=0&limit=0&status=created'

Respostas

OK.

Corpoapplication/json
Resposta
application/json
[
  {
    "payment_details": { … },
    "payment_system": { … },
    "purchase": { … },
    "transaction": { … },
    "user": { … }
  }
]

Encontrar transações (pesquisa rápida)

Pedido

Obtém uma lista de transação com base nos parâmetros de pesquisa especificados dentro de alguns segundos. Essa é uma alternativa à chamada de API Encontrar transações que retorna os dados nos formatos JSON, CSV ou XLS.

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.

Consulta
transaction_idinteger

ID de transação. Ou isso ou external_id deve ser fornecido, mas não ambos.

external_idstring

ID de transação no jogo. É diferente para cada pagamento. Ou isso ou transaction_id deve ser fornecido, mas não ambos.

curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/pt/api/pay-station/merchants/{merchant_id}/reports/transactions/simple_search?transaction_id=0&external_id=string'

Respostas

A lista de transações foi retornada com sucesso.

Corpoapplication/jsonArray [
payment_detailsobject

Dados de pagamento.

transactionobject

Dados de transação.

userobject

Dados do usuário.

]
Resposta
application/json
[
  {
    "payment_details": { … },
    "transaction": { … },
    "user": { … }
  }
]

Obtém resumos de pagamentos na moeda

Pedido

Obtém resumos de pagamentos na moeda.

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.

Consulta
datetime_fromstring(datetime)

Início do período.

datetime_tostring(datetime)

Fim do período.

legal_entity_idinteger

ID da entidade legal do desenvolvedor.

statusstring

Status da transação.

Enum"done""canceled""error""refunded"
curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/pt/api/pay-station/merchants/{merchant_id}/reports/transactions/summary/transfer?datetime_from=string&datetime_to=string&legal_entity_id=0&status=done'

Respostas

OK.

Corpoapplication/json
Resposta
application/json
[
  {
    "DirectTaxesOfPayments": 0.46,
    "IsoCurrency": "RUB",
    "PaymentsAmount": 223679.84,
    "SumCommissionAgent": 11329.58,
    "SumCommissionUserTaxes": 153.67,
    "SumItems": 571325.13,
    "SumNominalSum": 214792.98,
    "SumOutProject": 551096.13,
    "SumPayoutSum": 193316.71,
    "TaxesOfPayments": 171.56
  },
  {
    "DirectTaxesOfPayments": 0.14,
    "IsoCurrency": "USD",
    "PaymentsAmount": 482.58,
    "SumCommissionAgent": 77.51,
    "SumCommissionUserTaxes": 0.07,
    "SumItems": 243777.62,
    "SumNominalSum": 493.09,
    "SumOutProject": 241787.62,
    "SumPayoutSum": 462.62,
    "TaxesOfPayments": 0.14
  },
  {
    "DirectTaxesOfPayments": 0.07,
    "IsoCurrency": "EUR",
    "PaymentsAmount": 608.2,
    "SumCommissionAgent": 55.71,
    "SumCommissionUserTaxes": 90.94,
    "SumItems": 156238.62,
    "SumNominalSum": 607.26,
    "SumOutProject": 156158.62,
    "SumPayoutSum": 460.8,
    "TaxesOfPayments": 90.94
  }
]

Obter transação

Pedido

Obtém os dados de transação completos por ID.

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.

curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/pt/api/pay-station/merchants/{merchant_id}/reports/transactions/{transaction_id}/details'

Respostas

As informações de transação foram retornadas com sucesso.

Corpoapplication/jsonArray [
customer_detailsobject
finance_detailsobject
payment_detailsobject
subscription_detailsobject
transaction_detailsobject
]
Resposta
application/json
[
  {
    "customer_details": { … },
    "finance_details": { … },
    "payment_details": { … },
    "subscription_details": { … },
    "transaction_details": { … }
  }
]

Obtém pagamentos

Pedido

Lista todos os pagamentos de um período.

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.

Consulta
datetime_fromstring(datetime)

Início do período.

datetime_tostring(datetime)

Fim do período.

legal_entity_idinteger

ID da entidade legal do desenvolvedor.

statusstring

Status de pagamento.

Enum ValorDescrição
hold

Aguardando por uma solicitação para prosseguir.

paid

Pagamento concluído.

ready

Pagamento em progresso.

curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/pt/api/pay-station/merchants/{merchant_id}/reports/transfers?datetime_from=string&datetime_to=string&legal_entity_id=0&status=hold'

Respostas

OK.

Corpoapplication/json
Resposta
application/json
[
  {
    "canceled": 0,
    "payout": { … },
    "rate": 1,
    "transfer": { … }
  }
]

Reembolso

Operações

Testes

Operações