Group Методи для роботи з магазином
Перед інтеграцією ознайомтеся з розділом Початок роботи з API
Запит балансу shop_balance [/shop_balance]
Метод дозволяє дізнатися баланс вашого магазину Feennex.
Для методу потрібно сформувати підпис за допомогою обов'язкових параметрів запиту: now і shop_id. Сформований підпис потрібно передати в параметрі sign.
Натисніть на кнопку в кінці опису методу, щоб побачити опис параметрів запиту і відповіді.
Баланс магазину складається з наступних значень:
available– Сума, яка доступна для виплат, за виняткомrolling_reservefrozen– Заморожена сума на балансі. Наприклад, для виплати, яка знаходиться в обробціhold– Тимчасово утримана сума. Наприклад, при перевірці вхідного надходження
Приклад запиту
curl https://core.feennex.com/shop_balance \
-H 'Content-Type: application/json' \
-d '{
"shop_id":112,
"now": "2024-04-12T06:18:34.719Z",
"sign": "77c6cc948751ee"
}'
Натисніть на кнопку нижче, щоб переглянути параметри методу та тіла запиту і відповіді.
Запитати баланс [POST]
-
Request (application/json)
-
Headers
-
Attributes
- shop_id: 1 (number, required) - Идентификатор вашего магазина, с которого проходит выплата
- shop_payment_id (string, optional) - Идентификатор транзакции на стороне магазина
- now (string, required) - Дата и время, когда вы отправляете запрос. Формат: ISO 8601
- sign: 32b2c32caa8ad (string, required) - Подпись запроса
-
Body
{
"now": "2024-04-12T06:18:34.719Z",
"shop_id": 112,
"sign": "77c6cc948751ee"
}
-
-
Response 200 ()
-
Body
{
"data": {
"balances": [
{
"available": 100.0,
"currency": 978,
"frozen": 0.0,
"hold": 0.0,
"rolling_reserve": 0.0
},
{
"available": 200.0,
"currency": 840,
"frozen": 0.0,
"hold": 0.0,
"rolling_reserve": 0.0
},
{
"available": 93.0,
"currency": 840,
"frozen": 0.0,
"hold": 0.0,
"rolling_reserve": 0.0
}
],
"shop_id": 112
},
"error_code": 0,
"message": "Ok",
"result": true
} -
Attributes (object)
- data (object, required) - Объект содержит информацию о балансе
- balances (array, required) - баланс магазина в разрезе валют
- object
- available: 93.0 (number, required) - Доступный баланс магазина
- currency: 840 (number, required) - Валюта баланса. Возможные значения валют
- hold: 0.0 (number, required) - Временно удержанные средства, например, при проверке входящего поступления
- frozen: 20.0 (number, required) - Замороженные средства на балансе магазина
- rolling_reserve 0.0 (number, optional) - Временно удержанные денежные средства на балансе магазина
- object
- shop_id: 112 (number, required) - Идентификатор вашего магазина Feennex
- balances (array, required) - баланс магазина в разрезе валют
- error_code: 0 (number, required) - Код ошибки. Возможные значения кодов ошибок
- message: Ok (string, required) - Описание ошибки. По значению этого параметра можно определить успешность запроса и узнать, что пошло не так
- result: true (boolean, required) - Успешность запроса
- data (object, required) - Объект содержит информацию о балансе
-
Отримання доступних платіжних напрямків shop_input_config/shop [/shop_input_config/shop]
Метод повертає доступні для вашого магазину платіжні напрямки. Наприклад, оплата банківською карткою або гаманцем Feennex.
Для методу потрібно сформувати підпис за допомогою обов'язкових параметрів запиту: now і shop_id*. Сформований підпис потрібно передати в параметрі sign.
Натисніть на кнопку в кінці опису методу, щоб побачити опис параметрів запиту і відповіді.
Приклад запиту
curl https://core.feennex.com/shop_input_config/shop \
-H 'Content-Type: application/json' \
-d '{
"shop_id":112,
"now": "2024-04-12T06:18:34.719Z",
"sign": "77c6cc948751ee"
}'
Нажмите на кнопку ниже, чтобы просмотреть параметры метода и тела запроса и ответа.
POST Отримати доступні платіжні напрямки [POST]
-
Request (application/json)
-
Headers
-
Attributes
- now (string, required) - Дата и время, когда вы отправляете запрос. Формат: ISO 8601
- shop_id: 112 (number, required) - Идентификатор магазина, с которого осуществляется выплата
- sign: 32b2c32caa8ad (string, required) - Подпись запроса
-
Body
{
"now": "03.09.2024 11:19:55",
"shop_id": 3,
"sign": "588485c9d7f0d"
}
-
-
Response 200 ()
-
Body
{
"data": [
{
"id": 1,
"is_bill_config": true,
"name": "Feennex Wallet",
"payways": [
{
"alias": "feennex_usd",
"currency": 840,
"fee_config": {
"fix": 0,
"percent": 7
},
"fee_part_config": {
"fix_part": 1,
"percent_part": 1
},
"id": 83543,
"is_active": true,
"max_amount": 1000000,
"min_amount": 1
}
],
"rating": 1
},
{
"id": 267,
"name": "СБП h2h",
"payways": [
{
"add_ons_config": {
"email": {
"example": "[email protected]",
"label": {
"en": "E-mail:",
"ru": "E-mail:",
"uk": "E-mail:"
},
"regex": "^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+.[a-zA-Z0-9-.]+$",
"title": {
"en": "Enter your Email",
"ru": "Введите Ваш Email",
"uk": "Введіть Ваш Email"
}
}
},
"alias": "sbp_h2h_usd",
"currency": 840,
"fee_config": {
"fix": 0,
"percent": 10
},
"fee_part_config": {
"fix_part": 0,
"percent_part": 1
},
"id": 797,
"is_active": true,
"max_amount": 100000,
"min_amount": 300
}
],
"rating": 94
},
{
"id": 268,
"name": "Банк h2h",
"payways": [
{
"add_ons_config": {
"email": {
"example": "[email protected]",
"label": {
"en": "E-mail:",
"ru": "E-mail:",
"uk": "E-mail:"
},
"regex": "^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+.[a-zA-Z0-9-.]+$",
"title": {
"en": "Enter your e-mail",
"ru": "Введите Ваш e-mail",
"uk": "Введіть Ваш e-mail"
}
}
},
"alias": "bank_h2h_usd",
"currency": 840,
"fee_config": {
"fix": 0,
"percent": 10
},
"fee_part_config": {
"fix_part": 0,
"percent_part": 1
},
"id": 798,
"is_active": true,
"max_amount": 100000,
"min_amount": 300
}
],
"rating": 95
},
{
"id": 119,
"name": "Банковские карты РФ",
"payways": [
{
"add_ons_config": null,
"alias": "card_rub",
"currency": 643,
"fee_config": {
"fix": 0,
"percent": 15
},
"fee_part_config": {
"fix_part": 0,
"percent_part": 1
},
"id": 864,
"is_active": true,
"max_amount": 140000,
"min_amount": 300
}
],
"rating": 108
}
],
"error_code": 0,
"message": "Ok",
"result": true
} -
Attributes (object)
- data (object, required) - Объект содержит данные о доступных платежных направлениях
- object
- id: 3 (number, required) - Идентификатор платежного метода
- is_bill_config (boolean, optional) - Параметр, который указывает, что направление предназначено для платежей
- name: MIR (string, required) - Наименование платежного метода
- payways (array, required) - Платежные направления, которые включены магазину
- object
- add_ons_config (string, optional) - Дополнительная информация, если она требуется по платежному направлению
- alias: card_usd (string, required) - Наименование платежного направления
- currency: 840 (number, required) - Валюта в разрезе платежного направления. Возможные значения валют
- fee_config (object) - настройки распределения комисии между магазином и плательщиком
- fix: 0.0 (number, required) - фиксированная комиссия
- percent: 6.0 (number, required) - распределение процентной комиссии (0,0-1,0)
- fee_part_config (object, optional) - настройки распределения комисии между магазином и плательщиком
- fix: 0.0 (number, required) - фиксированная комиссия
- percent: 6.0 (number, required) - процентная комиссия
- id: 154 (number, required) - Id платежного направления
- is_active: true (boolean, required) - статус активации
- max_amount: 100000.0 (number, required) - максимальная сумма платежа в разрезе направления
- min_amount: 1.0 (number, required) - минимальная сумма платежа в разрезе направления
- object
- rating (number, optional) - Служебный параметр
- object
- error_code: 0 (number, required) - Код ошибки. Возможные значения кодов ошибок
- message: Ok (string, required) - Описание ошибки. По значению этого параметра можно определить успешность запроса и узнать, что пошло не так
- result: true (boolean, required) - Успешность запроса
- data (object, required) - Объект содержит данные о доступных платежных направлениях
-
Отримання доступних напрямків для виплат shop_output_config/shop [/shop_output_config/shop]
Метод повертає доступні для вашого магазину напрямки для виплат. Наприклад, виплата на банківську картку.
Для методу потрібно сформувати підпис за допомогою обов'язкових параметрів запиту: now і shop_id. Сформований підпис потрібно передати в параметрі sign.
Натисніть на кнопку в кінці опису методу, щоб побачити опис параметрів запиту і відповіді.
Приклад запиту
curl https://core.feennex.com/shop_output_config/shop \
-H 'Content-Type: application/json' \
-d '{
"shop_id":3,
"now": "03.09.2024 11:19:55",
"sign": "588485c9d7f0d"
}'
Натисніть на кнопку нижче, щоб переглянути параметри методу та тіла запиту і відповіді.
POST Отримати доступні напрямки для виплат [POST]
-
Request (application/json)
-
Headers
-
Attributes
- now (string, required) - Дата и время, когда вы отправляете запрос. Формат: ISO 8601
- shop_id: 1 (number, required) - Идентификатор вашего магазина, с которого проходит выплата
- sign: 32b2c32caa8ad (string, required) - Подпись запроса
-
Body
{
"now": "03.09.2024 11:19:55",
"shop_id": 3,
"sign": "588485c9d7f0d"
}
-
-
Response 200 ()
-
Body
{
"data":[
{
"id": 1,
"name": "MIR",
"payways": [
{
"account_info_config":
{
"account":
{
"regex": "^(4|5|6)[0-9]{15,17}$",
"title": "Номер карты"
}
},
"alias":"card_eur",
"currency": 978,
"fee_config":
{
"fix": 10.0,
"percent": 1.5
},
"info_id": null,
"max_amount": 14999.0,
"min_amount": 1.0
}
],
"rating": 1
},
{
"id": 3,
"is_transfer_config": true,
"name": "Feennex",
"payways": [
{
"account_info_config":
{
"payee_account": {
"regex": "^20[\\d]{10}$|^([a-zA-Z0-9_-]+\\.)*[a-zA-Z0-9_-]+@[a-zA-Z0-9_-]+(\\.[a-zA-Z0-9_-]+)*\\.[a-zA-Z]{2,6}$",
"title": "Номер кошелька или email"
}
},
"alias": "feennex_usd",
"currency": 840,
"fee_config":
{
"fix": 0.0,
"percent": 0.0
},
"info_id": null,
"max_amount": 10000.0,
"min_amount": 0.5
}
],
"rating": 22
}
],
"error_code": 0,
"message": "Ok",
"result": true
} -
Attributes (object)
- data (object, required) - Объект содержит данные о доступных направлениях для выплат
- id: 3 (number, required) - Идентификатор платежного метода
- is_transfer_config (boolean, optional) - Параметр, который указывает, что направление предназначено для выплат
- name: MIR (string, required) - Наименование платежного метода
- payways (array, required) - Направления для выплат, которые подключены для вашего магазина
- object
- account_info_config (object) - Информация об аккаунте, на который будет выплата
- account (object) - Дополнительная информация об аккаунте
- regex (string, required) - Регулярное выражение, которому должен соответствовать аккаунт
- title (string, required) - Название поля аккаунта
- account (object) - Дополнительная информация об аккаунте
- account_info_config (object) - Информация об аккаунте, на который будет выплата
- alias: card_usd (string, required) - наименование платежного направления
- currency: 840 (number, required) - валюта в разрезе платежного направления. Возможные значения валют
- fee_config (object) - Размер комиссии
- fix: 0.0 (number, required) - фиксированная комиссия
- percent: 6.0 (number, required) - процентная комиссия
- info_id: null (string, required) - служебный параметр
- max_amount: 10000.0 (number, required) - максимальная сумма платежа в разрезе направления
- min_amount: 0.5 (number, required) - минимальная сумма платежа в разрезе направления
- object
- rating: 22 (number, required) - Служебный параметр
- error_code: 0 (number, required) - Код ошибки. Возможные значения кодов ошибок
- message: Ok (string, required) - Описание ошибки. По значению этого параметра можно определить успешность запроса и узнать, что пошло не так
- result: true (boolean, required) - Успешность запроса
- data (object, required) - Объект содержит данные о доступных направлениях для выплат
-
Запит доступності сервісу Feennex check_status [/check_status]
Метод дозволяє дізнатися доступність сервісу Feennex.
Приклад запиту
curl -X GET \
--location 'https://core.feennex.com/check_status' \
Натисніть на кнопку нижче, щоб переглянути параметри методу та тіла запиту і відповіді.
GET Запитати доступність сервісу [GET]
-
Headers
-
Content-Type: application/json
-
Request
{
https://core.feennex.com/check_status
} -
Response 200 ()
-
Body
{
"status": "OK"
} -
Attributes (object)
- status: ОК (string, required) - Статус доступности сервиса
-