Перейти к содержимому
/
Детализация выплат по вал...

Pay Station API (2.0)

Введение

  • Версия: 2.0.0
  • Серверы:
    • https://api.xsolla.com/api

Pay Station позволяет вам монетизировать игру, предоставляя пользователям удобный интерфейс для оплаты покупок во внутриигровом магазине. Чтобы настроить открытие платежного интерфейса, следуйте инструкции.

В Pay Station API представлены следующие группы методов:

  • Токен — содержит метод для создания токена с любыми параметрами пользователя для дальнейшей обработки платежа через платежный интерфейс.
  • Токенизация — содержит методы для проведения безопасных платежей без открытия платежного интерфейса и непосредственного участия пользователя.
  • Отчеты — содержит методы для возвращения информации о транзакциях пользователя, а также создания отчетов и получения детализации выплат по валютам.
  • Возврат платежа — содержит методы для создания запросов на отмену платежа и на частичный возврат платежа.
  • Тестирование — содержит метод для тестирования процесса чарджбэка.

Подробные сведения о настройке платежного интерфейса приведены в руководстве по интеграции решения Payments.

Примечание

Вы также можете использовать раздел Xsolla Base API из коллекции Postman, чтобы протестировать методы, необходимые для интеграции.

Скачать описание OpenAPI
index.json
index.yaml
Языки
Серверы
https://api.xsolla.com/merchant/v2/
Mock server
https://xsolla.redocly.app/_mock/ru/api/pay-station/

Токен

Операции

Токенизация

Операции

Отчеты

Операции

Список отчетов

Запрос

Список финансовых отчетов за указанный период времени.

Внимание

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

Безопасность
basicAuth
Путь
merchant_idintegerобязательный

ID продавца.

Запрос
datetime_fromstring(datetime)обязательный

Начало периода в формате ГГГГ-ММ-ДД. Не обязателен, если передан хотя бы один из следующих параметров:

  • transfer_id;
  • report_id.

Пример: datetime_from=2023-02-08
datetime_tostring(datetime)обязательный

Конец периода в формате ГГГГ-ММ-ДД. Не обязателен, если передан хотя бы один из следующих параметров:

  • transfer_id;
  • report_id.
Диапазон дат между datetime_from и datetime_to не может превышать 92 дня.

Пример: datetime_to=2023-03-08
curl -i -X GET \
  -u <username>:<password> \
  'https://api.xsolla.com/merchant/v2/merchants/{merchant_id}/reports?datetime_from=2023-02-08&datetime_to=2023-03-08'

Ответы

OK.

Телоapplication/json
Ответ
application/json
[
  {
    "agreement_document_id": "Organization Inc_RUB",
    "currency": "RUB",
    "is_direct_payout": false,
    "is_draft_by_agreement": true,
    "month": "January",
    "report_id": 57613,
    "year": 2019
  },
  {
    "agreement_document_id": "Organization Inc_EUR",
    "currency": "USD",
    "is_direct_payout": false,
    "is_draft_by_agreement": true,
    "month": "January",
    "report_id": 57619,
    "year": 2019
  }
]

Список транзакций

Запрос

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

Внимание

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

Безопасность
basicAuth
Путь
merchant_idintegerобязательный

ID продавца.

formatstringобязательный

Формат данных.

Перечисление"json""csv""xls"
Запрос
datetime_fromstring(datetime)обязательный

Начало периода в формате ГГГГ-ММ-ДД. Не обязателен, если передан хотя бы один из следующих параметров:

  • transfer_id;
  • report_id.

Пример: datetime_from=2023-02-08
datetime_tostring(datetime)обязательный

Конец периода в формате ГГГГ-ММ-ДД. Не обязателен, если передан хотя бы один из следующих параметров:

  • transfer_id;
  • report_id.
Диапазон дат между datetime_from и datetime_to не может превышать 92 дня.

Пример: datetime_to=2023-03-08
in_transfer_currencyintegerобязательный

Получение финансовых данных в валюте выплаты (по умолчанию используется валюта способа оплаты). Не обязателен, если передан хотя бы один из следующих параметров:

  • transfer_id;
  • report_id.

show_totalboolean

Включать ли в отчет итоговые данные по транзакциям. Доступно только для выгрузки в формате CSV. По умолчанию true.

merchant_of_recordsstring or null

Зарегистрированный продавец. Может принимать значения xsolla, merchant или может не передаваться. Если merchant, возвращаются транзакции, сделанные через прямые аккаунты партнера. Если xsolla, возвращаются транзакции, сделанные не через прямые аккаунты партнера. Если значение не указано, возвращаются все транзакции.

Перечисление ЗначениеОписание
merchant

Возвращаются транзакции, сделанные через прямые аккаунты партнера.

xsolla

Возвращаются транзакции, сделанные не через прямые аккаунты партнера.

project_idinteger

ID проекта.

show_dry_runboolean

Должны ли в ответе быть тестовые платежи.

transfer_idinteger

ID выплаты.

report_idinteger

ID финансового отчета.

offsetinteger

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

limitinteger

Лимит количества отображаемых транзакций на странице. Если передан этот параметр, параметры datetime_from и datetime_to передавать не нужно.

statusstring

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

Перечисление"done""canceled""error""refunded"
curl -i -X GET \
  -u <username>:<password> \
  'https://api.xsolla.com/merchant/v3/merchants/{merchant_id}/reports/transactions/registry.{format}?datetime_from=2023-02-08&datetime_to=2023-03-08&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'

Ответы

Список транзакций успешно получен.

Телоapplication/jsonArray [
payment_detailsobject

Информация о платеже.

payment_details.​chargebackPenaltyobject
payment_details.​chargebackPenalty.​amountnumber(float)
payment_details.​commission_agentobject
payment_details.​commission_agent.​amountnumber(float)
payment_details.​commission_agent.​percentnumber(float)
payment_details.​commission_agent_fixedinteger
payment_details.​commission_psobject
payment_details.​commission_ps.​amountnumber(float)
payment_details.​commission_ps.​fixed_amountinteger
payment_details.​commission_ps.​percentnumber(float)
payment_details.​commission_ps_from_vatobject
payment_details.​commission_ps_from_vat.​amountnumber(float)
payment_details.​commission_userobject
payment_details.​commission_user.​amountnumber(float)
payment_details.​commission_user.​percentnumber(float)
payment_details.​commission_xsollaobject
payment_details.​commission_xsolla.​amountnumber(float)
payment_details.​commission_xsolla.​fixed_amountinteger
payment_details.​commission_xsolla.​percentnumber(float)
payment_details.​cpa_network_commissionobject
payment_details.​cpa_network_commission.​amountnumber(float)
payment_details.​cpa_network_commission.​percentnumber(float)
payment_details.​direct_whtobject
payment_details.​direct_wht.​amountnumber(float)
payment_details.​direct_wht.​percentnumber(float)
payment_details.​paymentobject
payment_details.​payment.​amountnumber(float)
payment_details.​payment.​amount_from_psinteger
payment_details.​payment.​currencystring
payment_details.​payoutobject
payment_details.​payout.​amountnumber(float)
payment_details.​payout.​amount_from_psnumber(float)
payment_details.​payout.​currencystring
payment_details.​payout.​fx_ratenumber(float)
payment_details.​payout.​percentnumber(float)
payment_details.​refundPenaltyobject
payment_details.​refundPenalty.​amountnumber(float)
payment_details.​repatriation_costsobject
payment_details.​repatriation_costs.​amountnumber(float)
payment_details.​repatriation_costs.​percentnumber(float)
payment_details.​sales_taxobject
payment_details.​sales_tax.​amountnumber(float)
payment_details.​sales_tax.​percentnumber(float)
payment_details.​vatobject
payment_details.​vat.​amountnumber(float)
payment_details.​vat.​percentnumber(float)
payment_details.​vat.​user_amountinteger
payment_details.​vat.​user_percentinteger
purchaseobject

Информация о заказе.

purchase.​friendobject
purchase.​friend.​emailstring or null
purchase.​friend.​user_idstring or null
purchase.​items_amountinteger
purchase.​pin_codesobject
purchase.​pin_codes.​amountnumber or null(float)
purchase.​pin_codes.​contentstring or null
purchase.​pin_codes.​currencystring or null
purchase.​purchase_amountnumber(float)
purchase.​simple_checkoutobject
purchase.​simple_checkout.​amountnumber or null(float)
purchase.​simple_checkout.​currencystring or null
purchase.​subscriptionobject
purchase.​subscription.​namestring or null
purchase.​subscription.​plan_idinteger or null
purchase.​subscription.​product_idstring or null
purchase.​subscription.​product_namestring or null
purchase.​subscription.​subscription_idinteger or null
purchase.​virtual_currencyobject
purchase.​virtual_currency.​amountnumber(float)
purchase.​virtual_currency.​currencystring
purchase.​virtual_currency_amountinteger
purchase.​virtual_itemsobject
purchase.​virtual_items.​amountnumber or null(float)
purchase.​virtual_items.​contentstring or null
purchase.​virtual_items.​currencystring or null
transactionobject

Информация о транзакции.

transaction.​custom_parametersobject or null
transaction.​direct_accountinteger
transaction.​dry_runinteger
transaction.​external_idstring or null
transaction.​idinteger
transaction.​payment_methodobject
transaction.​payment_method.​classstring
transaction.​payment_method.​idinteger
transaction.​payment_method.​namestring
transaction.​projectobject
transaction.​project.​idinteger
transaction.​project.​namestring
transaction.​refund_reasonstring or null
transaction.​refund_reason_commentstring or null
transaction.​statusstring
Перечисление"created""processing""done""canceled""error""refunded""partiallyRefunded""awaitingRefund""disputeFee"
transaction.​transfer_datestring(datetime)
userobject

Объект с информацией о пользователе.

user.​countrystring

Используется двухбуквенное обозначение страны согласно стандарту ISO 3166-1 alpha-2.

user.​customstring or null
user.​emailstring

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

user.​idstring

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

user.​ipstring
user.​marketplacestring
user.​namestring

Ник пользователя.

user.​phonestring or null

Номер телефона пользователя.

user_balanceobject

Баланс пользователя.

user_balance.​payment_currencyobject

Предпочтительная валюта платежа.

user_balance.​payment_currency.​deduction_amountnumber(float)
user_balance.​payment_currency.​payout_amount_from_balancenumber(float)
user_balance.​payment_currency.​purchase_amount_from_balancenumber(float)
]
Ответ
application/json
[
  {
    "payment_details": { … },
    "purchase": { … },
    "transaction": { … },
    "user": { … },
    "user_balance": { … }
  }
]

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

Запрос

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

Внимание

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

Безопасность
basicAuth
Путь
merchant_idintegerобязательный

ID продавца.

formatstringобязательный

Формат данных.

Перечисление"json""csv""xls"
Запрос
datetime_fromstring(datetime)

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

datetime_tostring(datetime)

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

project_idinteger

ID проекта.

transaction_idinteger

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

typestring

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

Перечисление ЗначениеОписание
all

Все транзакции.

canceled

Отмененные транзакции, исключая тестовые.

test

Тестовые транзакции.

transferred

Успешные транзакции, исключая тестовые.

phonestring

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

user_idstring

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

user_namestring

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

user_customstring

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

emailstring<= 100 characters

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

external_idstring

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

order_idinteger

ID заказа. Вы можете использовать его при вызове метода API Получение заказа.

Пример: order_id=1234
offsetinteger

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

limitinteger

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

statusstring(status.enum)

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

Перечисление ЗначениеОписание
awaitingRefund

Транзакция ожидает решения по возврату платежа. После того как пользователь запросил возврат, служба поддержки Xsolla вручную обрабатывает запрос и принимает решение по возврату.

canceled

Возможны два случая:

  • Транзакция была отменена на стороне платежной системы. Например, в случае, когда у пользователя оказалось недостаточно средств на счету.
  • Платеж был возвращен пользователю.
created

Транзакция инициирована пользователем, но еще не прошла обработку.

done

Транзакция обработана успешно.

error

При обработке транзакции произошла ошибка. Такие платежи могут быть возвращены пользователю при обращении в службу поддержки Xsolla.

partiallyRefunded

Пользователь получил частичный возврат платежа.

processing

Транзакция находится в обработке.

refunded

Выполнен возврат платежа на Xsolla-баланс пользователя.

review

Обработка транзакции была приостановлена системой антифрода и сейчас транзакция находится в процессе дополнительной верификации.

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&transaction_id=0&type=all&phone=string&user_id=string&user_name=string&user_custom=string&email=string&external_id=string&order_id=1234&offset=0&limit=0&status=created'

Ответы

OK.

Телоapplication/json
Ответ
application/json
[
  {
    "payment_details": { … },
    "payment_system": { … },
    "purchase": { … },
    "transaction": { … },
    "user": { … }
  }
]

Быстрый поиск транзакций

Запрос

Быстрое получение списка транзакций на основе параметров поиска в течение нескольких секунд. Альтернатива методу API Поиск транзакций, который возвращает результаты поиска в формате JSON, CSV или XLS.

Внимание

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

Безопасность
basicAuth
Путь
merchant_idintegerобязательный

ID продавца.

Запрос
transaction_idinteger

ID транзакции. Обязательно передайте либо данный параметер, либо external_id, но не оба сразу.

external_idstring

ID транзакции в игре, уникальный для каждого платежа. Обязательно передайте либо данный параметер, либо transaction_id, но не оба сразу.

curl -i -X GET \
  -u <username>:<password> \
  'https://api.xsolla.com/merchant/v2/merchants/{merchant_id}/reports/transactions/simple_search?transaction_id=0&external_id=string'

Ответы

Список транзакций успешно получен.

Телоapplication/jsonArray [
payment_detailsobject

Информация о платеже.

payment_details.​paymentobject
payment_details.​payment.​amountnumber(float)

Сумма платежа.

payment_details.​payment.​currencystring

Валюта платежа. Используется трехбуквенное обозначение валюты согласно стандарту ISO 4217.

transactionobject

Информация о транзакции.

transaction.​external_idstring

ID транзакции в игре, уникальный для каждого платежа.

transaction.​idinteger

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

transaction.​payment_datestring

Дата платежа в формате ГГ-ММ-ДД.

transaction.​projectobject
transaction.​project.​idinteger

ID проекта. Вы можете найти этот параметр в Личном кабинете.

transaction.​project.​namestring

Название проекта.

transaction.​refund_reasonstring

Причина отмены.

transaction.​statusstring(status.enum)

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

Перечисление ЗначениеОписание
awaitingRefund

Транзакция ожидает решения по возврату платежа. После того как пользователь запросил возврат, служба поддержки Xsolla вручную обрабатывает запрос и принимает решение по возврату.

canceled

Возможны два случая:

  • Транзакция была отменена на стороне платежной системы. Например, в случае, когда у пользователя оказалось недостаточно средств на счету.
  • Платеж был возвращен пользователю.
created

Транзакция инициирована пользователем, но еще не прошла обработку.

done

Транзакция обработана успешно.

error

При обработке транзакции произошла ошибка. Такие платежи могут быть возвращены пользователю при обращении в службу поддержки Xsolla.

partiallyRefunded

Пользователь получил частичный возврат платежа.

processing

Транзакция находится в обработке.

refunded

Выполнен возврат платежа на Xsolla-баланс пользователя.

review

Обработка транзакции была приостановлена системой антифрода и сейчас транзакция находится в процессе дополнительной верификации.

userobject

Объект с информацией о пользователе.

user.​countrystring

Используется двухбуквенное обозначение страны согласно стандарту ISO 3166-1 alpha-2.

user.​emailstring

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

user.​idstring

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

user.​namestring

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

]
Ответ
application/json
[
  {
    "payment_details": { … },
    "transaction": { … },
    "user": { … }
  }
]

Детализация выплат по валютам

Запрос

Получение детализации выплат по валютам.

Внимание

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

Безопасность
basicAuth
Путь
merchant_idintegerобязательный

ID продавца.

Запрос
datetime_fromstring(datetime)

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

datetime_tostring(datetime)

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

legal_entity_idinteger

Уникальный ID юридического лица разработчика.

statusstring

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

Перечисление"done""canceled""error""refunded"
curl -i -X GET \
  -u <username>:<password> \
  'https://api.xsolla.com/merchant/v2/merchants/{merchant_id}/reports/transactions/summary/transfer?datetime_from=string&datetime_to=string&legal_entity_id=0&status=done'

Ответы

OK.

Телоapplication/json
Ответ
application/json
[
  {
    "DirectTaxesOfPayments": 0.46,
    "IsoCurrency": "RUB",
    "PaymentsAmount": 223679.84,
    "SumCommissionAgent": 11329.58,
    "SumCommissionUserTaxes": 153.67,
    "SumItems": 571325.13,
    "SumNominalSum": 214792.98,
    "SumOutProject": 551096.13,
    "SumPayoutSum": 193316.71,
    "TaxesOfPayments": 171.56
  },
  {
    "DirectTaxesOfPayments": 0.14,
    "IsoCurrency": "USD",
    "PaymentsAmount": 482.58,
    "SumCommissionAgent": 77.51,
    "SumCommissionUserTaxes": 0.07,
    "SumItems": 243777.62,
    "SumNominalSum": 493.09,
    "SumOutProject": 241787.62,
    "SumPayoutSum": 462.62,
    "TaxesOfPayments": 0.14
  },
  {
    "DirectTaxesOfPayments": 0.07,
    "IsoCurrency": "EUR",
    "PaymentsAmount": 608.2,
    "SumCommissionAgent": 55.71,
    "SumCommissionUserTaxes": 90.94,
    "SumItems": 156238.62,
    "SumNominalSum": 607.26,
    "SumOutProject": 156158.62,
    "SumPayoutSum": 460.8,
    "TaxesOfPayments": 90.94
  }
]

Информация о транзакции

Запрос

Полная информация о транзакции по ID.

Внимание

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

Безопасность
basicAuth
Путь
merchant_idintegerобязательный

ID продавца.

transaction_idintegerобязательный

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

curl -i -X GET \
  -u <username>:<password> \
  'https://api.xsolla.com/merchant/v2/merchants/{merchant_id}/reports/transactions/{transaction_id}/details'

Ответы

Информация о транзакции успешно получена.

Телоapplication/jsonArray [
customer_detailsobject
customer_details.​billing_addressstring
customer_details.​binstring
customer_details.​browser_languagestring
customer_details.​countrystring
customer_details.​ipstring
customer_details.​paystation_countrystring
customer_details.​phonestring or null
customer_details.​timezonestring
customer_details.​user_idstring
customer_details.​user_namestring
finance_detailsobject
finance_details.​direct_whtobject
finance_details.​direct_wht.​amountnumber(float)
finance_details.​direct_wht.​currencystring
finance_details.​dispute_feeobject
finance_details.​dispute_fee.​amountnumber(float)

Сумма комиссии за диспут в валюте платежа.

finance_details.​dispute_fee.​currencystring

Валюта платежа. Используется трехбуквенное обозначение валюты согласно стандарту ISO 4217.

finance_details.​dispute_fee.​datestring

Дата открытия диспута.

finance_details.​paymentobject
finance_details.​payment.​amountnumber(float)
finance_details.​payment.​currencystring
finance_details.​payment_method_feeobject
finance_details.​payment_method_fee.​amountnumber(float)
finance_details.​payment_method_fee.​currencystring
finance_details.​payment_method_sumobject
finance_details.​payment_method_sum.​amountnumber(float)
finance_details.​payment_method_sum.​currencystring
finance_details.​payoutobject
finance_details.​payout.​amountnumber(float)
finance_details.​payout.​currencystring
finance_details.​payout_currency_ratenumber(float)
finance_details.​repatriation_commissionobject
finance_details.​repatriation_commission.​amountnumber(float)
finance_details.​repatriation_commission.​currencystring
finance_details.​sales_taxobject
finance_details.​sales_tax.​amountnumber(float)
finance_details.​sales_tax.​currencystring
finance_details.​vatobject
finance_details.​vat.​amountnumber(float)
finance_details.​vat.​currencystring
finance_details.​xsolla_balance_sumobject
finance_details.​xsolla_balance_sum.​amountnumber(float)
finance_details.​xsolla_balance_sum.​currencystring
finance_details.​xsolla_feeobject
finance_details.​xsolla_fee.​amountnumber(float)
finance_details.​xsolla_fee.​currencystring
payment_detailsobject
payment_details.​card_holdernamestring or null
payment_details.​card_issuerstring
payment_details.​card_monthinteger
payment_details.​card_numberinteger
payment_details.​card_schemestring
payment_details.​card_yearinteger
payment_details.​customer_firstnamestring
payment_details.​customer_lastnamestring
payment_details.​enrollmentboolean
payment_details.​ps_accountstring
payment_details.​zip_codestring
subscription_detailsobject
subscription_details.​is_payment_from_subscriptionboolean
subscription_details.​is_subscription_createdboolean
transaction_detailsobject
transaction_details.​amountnumber(float)
transaction_details.​cancellation_datestring or null
transaction_details.​countrystring
transaction_details.​currencystring
transaction_details.​custom_parametersstring or null
transaction_details.​foreign_invoicestring or null
transaction_details.​gift_recipient_emailstring or null
transaction_details.​gift_recipient_idstring or null
transaction_details.​payment_datestring
transaction_details.​payment_methodstring
transaction_details.​payment_method_namestring
transaction_details.​projectinteger
transaction_details.​project_namestring
transaction_details.​purchaseobject
transaction_details.​purchase.​checkoutobject
transaction_details.​purchase.​checkout.​amountnumber(float)
transaction_details.​purchase.​checkout.​currencystring
transaction_details.​purchase.​pin_codesobject
transaction_details.​purchase.​pin_codes.​amountnumber(float)
transaction_details.​purchase.​pin_codes.​contentstring or null
transaction_details.​purchase.​pin_codes.​currencystring or null
transaction_details.​purchase.​totalobject
transaction_details.​purchase.​total.​amountnumber(float)
transaction_details.​purchase.​total.​currencystring
transaction_details.​purchase.​virtual_currencyobject
transaction_details.​purchase.​virtual_currency.​amountnumber(float)
transaction_details.​purchase.​virtual_currency.​currencystring
transaction_details.​purchase.​virtual_currency.​namestring
transaction_details.​purchase.​virtual_currency.​quantitystring
transaction_details.​purchase.​virtual_itemsobject or null
transaction_details.​purchase.​virtual_items.​amountnumber(float)
transaction_details.​purchase.​virtual_items.​contentstring
transaction_details.​purchase.​virtual_items.​currencystring
transaction_details.​refund_commentstring or null
transaction_details.​refund_reasonstring or null
transaction_details.​statusstring
transaction_details.​user_idstring
]
Ответ
application/json
[
  {
    "customer_details": { … },
    "finance_details": { … },
    "payment_details": { … },
    "subscription_details": { … },
    "transaction_details": { … }
  }
]

Список выплат

Запрос

Получение списка выплат за определенный период.

Внимание

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

Безопасность
basicAuth
Путь
merchant_idintegerобязательный

ID продавца.

Запрос
datetime_fromstring(datetime)

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

datetime_tostring(datetime)

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

legal_entity_idinteger

Уникальный ID юридического лица разработчика.

statusstring

Статус выплаты.

Перечисление ЗначениеОписание
hold

Ожидание запроса на обработку выплаты.

paid

Выплата совершена.

ready

Выплата в процессе.

curl -i -X GET \
  -u <username>:<password> \
  'https://api.xsolla.com/merchant/v2/merchants/{merchant_id}/reports/transfers?datetime_from=string&datetime_to=string&legal_entity_id=0&status=hold'

Ответы

OK.

Телоapplication/json
Ответ
application/json
[
  {
    "canceled": 0,
    "payout": { … },
    "rate": 1,
    "transfer": { … }
  }
]

Возврат платежа

Операции

Тестирование

Операции