Xsolla-logo

Get transactions

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

Gets all transactions for a specified period/payout/report. You can get the list in JSON, CSV, or XLS format.

Note

This API method can't be used under high load. When the number of requests is high, rate limits may apply. Contact your Account Manager to find out the rate limits for this API method.
SecuritybasicAuth
Request
path Parameters
merchant_id
required
integer

Merchant ID.

format
required
string

Data format.

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

Period start.

datetime_to
required
string <datetime>

Period end.

in_transfer_currency
required
integer

Converts all financial data to the payout currency (the pay-in currency is used by default).

show_total
required
boolean

Adds totals to the report.

merchant_of_records
string or null

Merchant of Record. Can be xsolla, merchant, or not specified. If merchant, returns transactions made via the partner’s gateways. If xsolla, returns transactions made not via the partner’s gateways. If not specified, returns all transactions.

Enum: Description
merchant

Returns transactions made via the partner’s gateways.

xsolla

Returns transactions made not via the partner’s gateways.

project_id
integer

Project ID.

show_dry_run
boolean

Whether to include test transactions.

transfer_id
integer

Payout ID.

report_id
integer

Financial report ID.

offset
integer

Number of the element from which the list is generated (the count starts from 0).

limit
integer

Limit for the number of elements on the page.

status
string

Transaction status.

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

The list of transactions was successfully returned.

Request samples
curl -i -X GET \
  -u <username>:<password> \
  'https://api.xsolla.com/merchant/v2/merchants/{merchant_id}/reports/transactions/registry.{format}?datetime_from=string&datetime_to=string&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'
Response samples
application/json
[
  • {
    }
]