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 within 5 to 10 minutes after executing the request.

Notice

This API call does not contain the project_id path parameter, so you need to use the API key that is valid in all the company’s projects to set up authorization.

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.

transaction_id

integer

Transaction ID.

type

string

Type of transactions shown in the search results:

Enum:	Description
all	All transactions.
transferred	Successful transactions excluding test transactions.
canceled	Canceled transactions excluding test transactions.
test	Test transactions.

phone

string

Phone number in international format.

user_id

string

Unique user ID in the game stored on your side. Make sure you pass the existing user ID. In case an error occurs, refer to the answers to the FAQs.

user_name

string

Username.

user_custom

string

Custom parameter for user identification.

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.

status

string

A transaction status.

Enum:	Description
created	The user initiated the transaction but it has not been processed yet.
processing	The transaction is being processed.
review	Transaction processing has been suspended by the anti-fraud system, and the transaction is currently under additional verification.
error	An error occurred while processing the transaction. Such payments can be refunded by contacting Xsolla customer support.
done	The transaction was successfully processed.
awaitingRefund	The transaction is awaiting a decision on refund. After the user requested a refund, Xsolla customer support manually processes the request and makes a decision on the refund.
refunded	A refund was made to the user’s Xsolla balance.
canceled	There are two possible scenarios: The transaction has been canceled on the payment system’s side. For example, there were insufficient funds in user account. The payment was refunded to the user.
partiallyRefunded	The user received a partial refund.

Responses

200

OK.

Request samples

Response samples

application/json

[{"transaction": {"project": {"id": 123456,
"name": "Example"
},
"payment_method": {"id": 1,
"name": "PayPal"
},
"transfer_date": "2021-10-20",
"id": 123456789,
"refund_reason": null,
"status": "done",
"external_id": "example-external-id",
"create_date": "2021-10-20",
"dry_run": 0,
"is_refund_allowed": 0
},
"user": {"id": "example-id",
"name": "Example",
"custom": null,
"email": "email@example.com",
"phone": null,
"country": "RU"
},
"payment_details": {"payment": {"currency": "RUB",
"amount": 7.96,
"amount_from_ps": 7.96
},
"sales_tax": {"percent": 0,
"amount": 0
}
},
"purchase": {"virtual_currency": {"amount": 0,
"name": null
},
"virtual_items": null,
"simple_checkout": {"amount": 7.96,
"currency": "RUB"
},
"pin_codes": {"amount": null,
"currency": null,
"content": null
},
"subscription": {"name": null
}
},
"payment_system": {"decline_reason": null
}
}
]