Этот API-метод используется для получения доступных метод ПС. Ниже приведена структура запроса и описание параметров.
URL:
https://api-gateway.sandbox.idynsys.org/api/pay-aggregator/external-app/payment-methodshttps://api-gateway.idynsys.org/api/pay-aggregator/external-app/payment-methodsМетод запроса: GET
Заголовки запросе:
X-Client-Id: (обязательно). Идентификатор приложения, получаемый при регистрации приложения в системе B2B Backoffice.X-Authorization-Sign: (обязательно). Подпись запроса по секретному ключу приложения, который определяется в системе B2B Backoffice. Подпись формируется по алгоритму, описанному на странице “Подпись”Content-Type: (обязательно) Тип содержимого запроса, должно быть application/json.Параметры запроса:
paymentType: (обязательно) Тип платежа (deposit или withdrawal).trafficType: (обязательно) Тип трафика (ftd или trusted).amount: (не обязательно) Сумма платежа.riskGroupCode: (не обязательно) Код рисковой группы.currency: (не обязательно) Валюта платежа.trafficSegment: (не обязательно) Сегмент трафика.communicationType: (не обязательно) Тип коммуникации (h2h или h2c).Ответ возвращается в формате JSON.
1. Успешный ответ (статус 200)
При успешном выполнении запроса API возвращает ответ со статусом 200 OK, пример структуры:
[
{
"communicationType": "h2c",
"currency": "INR",
"description": "H2C UPI payment method",
"maxAmount": 800000,
"minAmount": 100,
"name": "UPI",
"trafficSegment": "OdeonPay"
"riskGroupCode": "HIGH",
"isPopular": true
}
]
Описание полей ответа внутри страктуры items:
| Наименование | Тип | Обязательное? | Описание |
communicationType |
string | Да | Тип коммуникации. |
maxAmount |
float | Да | Максимальная сумма платежа. |
minAmount |
float | Да | Минимальная сумма платежа. |
description |
string | Да | Описание метода платежной системы. |
name |
string | Да | Имя метода платежной системы (см список на странице API. Статус ордера). |
trafficSegment |
string | Да | Сегмент трафика, задается в валютном счета. |
currency |
string | Да | ISO код валюты |
riskGroupCode |
string | Да | Код рисковой группы |
isPopular |
boolean | Нет | Рекомендуемый метод |
Все элеменны приходят по уникальной связке полей: trafficType, trafficSegment, paymentType, name, currency, communicationType, riskGroupCode, isPopular. Если все существующии конфигурации не нужны, то необходимо использовать параметры запроса для фильтрации.
2. Ошибка параметров запроса (статус 400)
Если в запросе не указан ни id, ни sessionId - API вернет ответ со статусом 400 Bad Request.
Пример структуры ответа
{
"success": false,
"message": "invalid amount"
}
3. Ошибка доступа (статус 403)
Если подпись некорректна, секретный ключ не совпадает с ключом, зарегистрированном в системе Billing, отсутствует или неактивно приложение, определенное в заголовке запроса X-Client-Id, то API вернет ответ со статусом 403 Forbidden
Пример структуры ответа
{
"success": false,
"message": "access denied"
}