OK.
Pay Station API (2.0)
- Версия: 2.0.0
- Серверы:
https://api.xsolla.com/api
Pay Station позволяет вам монетизировать игру, предоставляя пользователям удобный интерфейс для оплаты покупок во внутриигровом магазине. Чтобы настроить открытие платежного интерфейса, следуйте инструкции.
В Pay Station API представлены следующие группы методов:
- Токен — содержит метод для создания токена с любыми параметрами пользователя для дальнейшей обработки платежа через платежный интерфейс.
- Токенизация — содержит методы для проведения безопасных платежей без открытия платежного интерфейса и непосредственного участия пользователя.
- Отчеты — содержит методы для возвращения информации о транзакциях пользователя, а также создания отчетов и получения детализации выплат по валютам.
- Возврат платежа — содержит методы для создания запросов на отмену платежа и на частичный возврат платежа.
- Тестирование — содержит метод для тестирования процесса чарджбэка.
Подробные сведения о настройке платежного интерфейса приведены в руководстве по интеграции решения Payments.
Примечание
Вы также можете использовать раздел Xsolla Base API из коллекции Postman, чтобы протестировать методы, необходимые для интеграции.
Скачать описание OpenAPI
Языки
Серверы
Mock server
https://xsolla.redocly.app/_mock/ru/api/pay-station/
https://api.xsolla.com/merchant/v2/
Запрос
Загрузка списка сохраненных платежных аккаунтов пользователя.
Примечание
Данный метод API в тестовом окружении (sandbox-режиме) работает только с тестовыми картами, у которых нет проверки 3-D Secure.
Безопасность
basicAuth
Путь
Уникальный ID пользователя в игре, который хранится на вашей стороне. Убедитесь, что указываете существующий ID пользователя. При возникновении ошибок изучите ответы на частые вопросы.
- Mock serverhttps://xsolla.redocly.app/_mock/ru/api/pay-station/projects/{project_id}/users/{user_id}/payment_accounts
- https://api.xsolla.com/merchant/v2/projects/{project_id}/users/{user_id}/payment_accounts
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
-u <username>:<password> \
'https://xsolla.redocly.app/_mock/ru/api/pay-station/projects/{project_id}/users/{user_id}/payment_accounts?mode=string'Ответ
application/json
[ { "id": 4612345, "name": "PP_saved_account", "payment_system": { … }, "type": "paypal" } ]
Запрос
Удаление сохраненного платежного аккаунта.
Примечание
Данный метод API в тестовом окружении (sandbox-режиме) работает только с тестовыми картами, у которых нет проверки 3-D Secure.
Примечание
Вы можете использовать этот метод API в тестовом окружении (sandbox-режиме). Для этого передайте в запросе данные тестового аккаунта. Подробную информацию об открытии тестового окружения и сценариях тестирования читайте в инструкции.
Безопасность
basicAuth
Путь
Уникальный ID пользователя в игре, который хранится на вашей стороне. Убедитесь, что указываете существующий ID пользователя. При возникновении ошибок изучите ответы на частые вопросы.
Тип платежного аккаунта.
| Перечисление Значение | Описание |
|---|---|
| alipayplus_boost | Boost. |
| alipayplus_cn | Alipay. |
| alipayplus_dana | DANA. |
| alipayplus_gcash | GCash. |
| alipayplus_hk | Alipay (Гонконг). |
| alipayplus_kplus | K PLUS. |
| alipayplus_maya | Maya. |
| alipayplus_rabbitlinepay | Rabbit LINE pay. |
| alipayplus_tng | Touch 'n Go. |
| alipayplus_truemoney | TrueMoney Wallet. |
- Mock serverhttps://xsolla.redocly.app/_mock/ru/api/pay-station/projects/{project_id}/users/{user_id}/payment_accounts/{type}/{account_id}
- https://api.xsolla.com/merchant/v2/projects/{project_id}/users/{user_id}/payment_accounts/{type}/{account_id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X DELETE \
-u <username>:<password> \
'https://xsolla.redocly.app/_mock/ru/api/pay-station/projects/{project_id}/users/{user_id}/payment_accounts/{type}/{account_id}'Запрос
Оплата по сохраненному платежному аккаунту.
Примечание
Данный метод API в тестовом окружении (sandbox-режиме) работает только с тестовыми картами, у которых нет проверки 3-D Secure.
Внимание
Для корректной работы метода настройте время ожидания 2 минуты.
Безопасность
basicAuth
Путь
Телоapplication/jsonобязательныйУникальный ID пользователя в игре, который хранится на вашей стороне. Убедитесь, что указываете существующий ID пользователя. При возникновении ошибок изучите ответы на частые вопросы.
Тип платежного аккаунта.
| Перечисление Значение | Описание |
|---|---|
| alipayplus_boost | Boost. |
| alipayplus_cn | Alipay. |
| alipayplus_dana | DANA. |
| alipayplus_gcash | GCash. |
| alipayplus_hk | Alipay (Гонконг). |
| alipayplus_kplus | K PLUS. |
| alipayplus_maya | Maya. |
| alipayplus_rabbitlinepay | Rabbit LINE pay. |
| alipayplus_tng | Touch 'n Go. |
| alipayplus_truemoney | TrueMoney Wallet. |
Объект с параметрами для настройки антифрод-фильтров. Список параметров приведен ниже на этой странице. Чтобы добавить кастомные параметры, свяжитесь с вашим персональным менеджером или напишите на csm@xsolla.com.
- Mock serverhttps://xsolla.redocly.app/_mock/ru/api/pay-station/projects/{project_id}/users/{user_id}/payments/{type}/{account_id}
- https://api.xsolla.com/merchant/v2/projects/{project_id}/users/{user_id}/payments/{type}/{account_id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
-u <username>:<password> \
'https://xsolla.redocly.app/_mock/ru/api/pay-station/projects/{project_id}/users/{user_id}/payments/{type}/{account_id}' \
-H 'Content-Type: application/json' \
-d '{
"purchase": {
"description": {
"value": "currency purchase"
},
"virtual_currency": {
"quantity": 100
}
},
"settings": {
"currency": "USD",
"external_id": "ext123",
"mode": "sandbox"
},
"user": {
"ip": "111.11.11.11",
"legal": {
"address": "17 Crown Street London SW2 0JW United Kingdom",
"country": "GB",
"name": "My Awesome Company",
"vat_id": "GB111111111"
},
"name": "John Smith"
}
}'Ответ
application/json
{ "transaction_id": 123458390 }