Xsolla-logo

Obter transaçõesServer-sideAdmin

get/merchants/{merchant_id}/reports/transactions/registry.{format}

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.

SecuritybasicAuth
Request
path Parameters
merchant_id
required
integer

ID de comerciante.

format
required
string

Formato da data.

Enum: "json" "csv" "xls"
query Parameters
datetime_from
required
string <datetime>

O início do período no formato AAAA-MM-DD. Não é obrigatório se o parâmetro limit for passado.

Example: datetime_from=2023-02-08
datetime_to
required
string <datetime>

O fim do período no formato AAAA-MM-DD. Não é obrigatório se o parâmetro limit for passado. A diferença entre datetime_from e datetime_to não pode ser maior do que 92 dias.

Example: datetime_to=2023-03-08
in_transfer_currency
required
integer

Converte todos os dados financeiros à moeda de pagamento (a moeda local de pagamento é usada por padrão).

show_total
required
boolean

Adiciona os valores totais ao relatório.

merchant_of_records
string 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: Description
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_id
integer

ID do projeto.

show_dry_run
boolean

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

transfer_id
integer

ID de pagamento.

report_id
integer

ID de relatório financeiro.

offset
integer

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

limit
integer

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.

status
string

Status da transação.

Enum: "done" "canceled" "error"
Responses
200

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

Request samples
Response samples
application/json
[
  • {
    }
]