Ниже приведена информация об endpoint-ах и http-методах, используемых для поиска подписок:
| HTTP метод | URL | URL параметры | Headers | Request Params |
|---|---|---|---|---|
GET |
/payment/v1/subscription |
merchantId: Id мерчанта |
limit: лимит количества подписок на одной странице pageNumber: номер страницы поиска |
|
GET |
/payment/v1/subscription/:status |
status: Статус подписки (пример: /ACTIVE) |
merchantId: Id мерчанта |
limit: лимит количества подписок на одной странице pageNumber: номер страницы поиска |
GET |
/payment/v1/subscription/retrieve-subscription-id/:subscriptionId |
subscriptionId: Id подписки |
merchantId: Id мерчанта |
|
GET |
/payment/v1/subscription/retrieve-conversation-id/:conversationId |
conversationId: Значение созданное при инициализации страницы оплаты подписки |
merchantId: Id мерчанта |
Параметры, возвращаемые в результате процесса запроса повторной оплаты, подчиняются правилам Форматы возврата на главной странице API документации. При отсутствии систематичной или структурной ошибки, нижние параметры возвращающегося объекта в data параметрах следующие:
| Название параметра | Тип | Всегда доступен | Объяснение |
|---|---|---|---|
id |
long |
Да | ID значение подписки |
merchantId |
long |
Да | ID значение мерчанта |
cardUserKey |
string |
Да | Пользовательский ключ покупателя |
cardToken |
string |
Да | Пользовательский токен |
price |
string |
Да | Общая сумма подписки |
periodType |
string |
Да | Интервал подписки |
description |
string |
Да | Описание подписки |
nochargeDayCount |
string |
Да | Пробный период |
nextPaymentDate |
string |
Да | Дата обновления подписки |
status |
long |
Да | Статус подписки |
version |
string |
Да | Версия |
retryCount |
long |
Да | Количество попыток снятия платежа |
retryDate |
string |
Да | Дата повторной попытки платежа |
Типичный REST request может быть осуществлен следующим образом:
/payment/v1/subscription?pageNumber=1&limit=10
/payment/v1/subscription/ACTIVE?pageNumber=1&limit=10
/payment/v1/subscription/PASSIVE?pageNumber=1&limit=10
/payment/v1/subscription/retrieve-subscription-id/1
/payment/v1/subscription/retrieve-conversation-id/myConversationID_34
Не забудьте добавить поле merchantId в headers.