Поиск транзакций

Поиск транзакцийServer-sideAdmin

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

Возвращает список транзакций на основе параметров поиска. В ответе вы получите данные о всех платежах, совершенных в вашей игре, даже если они не были завершены успешно. Вы можете указать не только период выполнения транзакции, но и другие параметры, например, чтобы найти транзакции определенного пользователя или в определенном статусе платежа. Список будет доступен в формате JSON или CSV.

Внимание

Этот метод API не включает в себя path-параметр project_id, поэтому для авторизации вам необходимо использовать ключ API, который действует во всех проектах.

SecuritybasicAuth

Request

path Parameters

merchant_id required	integer ID продавца.
format required	string Формат данных. Enum: "json" "csv" "xls"

query Parameters

datetime_from

string <datetime>

Начало периода.

datetime_to

string <datetime>

Конец периода.

project_id

integer

ID проекта.

transaction_id

integer

ID транзакции.

type

string

Тип транзакций, которые появляются в результатах поиска.

Enum:	Description
all	Все транзакции.
canceled	Отмененные транзакции, исключая тестовые.
test	Тестовые транзакции.
transferred	Успешные транзакции, исключая тестовые.

phone

string

Номер телефона пользователя (в международном формате).

user_id

string

Уникальный ID пользователя в игре, который хранится на вашей стороне. Убедитесь, что указываете существующий ID пользователя. При возникновении ошибок изучите ответы на частые вопросы.

user_name

string

Имя пользователя.

user_custom

string

Дополнительный параметр идентификации пользователя.

string <= 100 characters

Email пользователя.

external_id

string

Идентификатор транзакции в игре. Должен быть уникальным для каждого платежа пользователя.

offset

integer

Номер элемента, с которого выполняется вывод на странице (нумерация ведется с 0).

limit

integer

Лимит количества элементов на странице.

status

string

Статус транзакции.

Enum:	Description
awaitingRefund	Транзакция ожидает решения по возврату платежа. После того как пользователь запросил возврат, служба поддержки Xsolla вручную обрабатывает запрос и принимает решение по возврату.
canceled	Возможны два случая: Транзакция была отменена на стороне платежной системы. Например, в случае, когда у пользователя оказалось недостаточно средств на счету. Платеж был возвращен пользователю.
created	Транзакция инициирована пользователем, но еще не прошла обработку.
done	Транзакция обработана успешно.
error	При обработке транзакции произошла ошибка. Такие платежи могут быть возвращены пользователю при обращении в службу поддержки Xsolla.
partiallyRefunded	Пользователь получил частичный возврат платежа.
processing	Транзакция находится в обработке.
refunded	Выполнен возврат платежа на Xsolla-баланс пользователя.
review	Обработка транзакции была приостановлена системой антифрода и сейчас транзакция находится в процессе дополнительной верификации.

Responses

200

OK.

Request samples

Response samples

application/json

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