Xsolla-logo

Find transactions

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

Gets a list of transactions based on specific search parameters. You can get the list in JSON, CSV, or XLS format.

SecuritybasicAuth
Request
path Parameters
merchant_id
required
integer

Merchant ID.

format
required
string

Data format.

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

Period start.

datetime_to
string <datetime>

Period end.

project_id
integer

Project ID.

show_dry_run
boolean

Whether to include test transactions.

transaction_id
integer

Transaction ID.

phone
string

Phone number in international format.

user_id
string

User ID.

user_name
string

Username.

user_custom
string

Custom parameter for user identification.

email
string <= 100 characters

User email.

external_id
string

Transaction ID in the game. Has to be unique for each user payment.

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.

transaction_type
string

Type of transaction.

Enum: "payment" "coupon" "inGamePurchase" "internal" "cancellation"
status
string

Additional transaction status.

Enum: "created" "processing" "done" "canceled" "error" "review" "refunded" "awaitingRefund"
Responses
200

OK.

Request samples
curl -i -X GET \
  -u <username>:<password> \
  'https://api.xsolla.com/merchant/v2/merchants/{merchant_id}/reports/transactions/search.{format}?datetime_from=string&datetime_to=string&project_id=0&show_dry_run=true&transaction_id=0&phone=string&user_id=string&user_name=string&user_custom=string&email=string&external_id=string&offset=0&limit=0&transaction_type=payment&status=created'
Response samples
application/json
[
  • {
    }
]