Методы для работы с магазином

Group Методы для работы с магазином

Перед интеграцией ознакомьтесь с разделом Началo работы с API

Запрос баланса shop_balance [/shop_balance]

Метод позволяет узнать баланс вашего магазина Feennex.

Для метода нужно сформировать подпись с помощью обязательных параметров запроса: now и shop_id. Сформированную подпись нужно передать в параметре sign.

Нажмите на кнопку в конце описания метода, чтобы увидеть описание параметров запроса и ответа.

Баланс магазина состоит из следующих значений:

available – Сумма, которая доступна для выплат, за исключением rolling_reserve
frozen – Замороженная сумма на балансе. Например, для выплаты, которая находится в обработке
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) - Временно удержанные денежные средства на балансе магазина
    - shop_id: 112 (number, required) - Идентификатор вашего магазина Feennex
  - error_code: 0 (number, required) - Код ошибки. Возможные значения кодов ошибок
  - message: Ok (string, required) - Описание ошибки. По значению этого параметра можно определить успешность запроса и узнать, что пошло не так
  - result: true (boolean, 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: LiqPay (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) - минимальная сумма платежа в разрезе направления
    - rating (number, optional) - Служебный параметр
- error_code: 0 (number, required) - Код ошибки. Возможные значения кодов ошибок
- message: Ok (string, required) - Описание ошибки. По значению этого параметра можно определить успешность запроса и узнать, что пошло не так
- result: true (boolean, required) - Успешность запроса

Получение доступных направлений для выплат shop_output_config/shop [/shop_output_config/shop]

Метод возвращает доступные для вашего магазина направления для выплат. Например, выплата на банковскую карту.

Нажмите на кнопку в конце описания метода, чтобы увидеть описание параметров запроса и ответа.

Пример запроса

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": "LiqPay",
                    "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: LiqPay (string, required) - Наименование платежного метода
  - payways (array, required) - Направления для выплат, которые подключены для вашего магазина
    - object
      - account_info_config (object) - Информация об аккаунте, на который будет выплата
        
        account (object) - Дополнительная информация об аккаунте
        
        regex (string, required) - Регулярное выражение, которому должен соответствовать аккаунт
        
        title (string, required) - Название поля аккаунта
    - 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) - минимальная сумма платежа в разрезе направления
  - rating: 22 (number, required) - Служебный параметр
- error_code: 0 (number, required) - Код ошибки. Возможные значения кодов ошибок
- message: Ok (string, required) - Описание ошибки. По значению этого параметра можно определить успешность запроса и узнать, что пошло не так
- result: true (boolean, required) - Успешность запроса

Запрос доступности сервиса Feennex check_status [/check_status]

Метод позволяет узнать доступность сервиса Feennex.

Пример запроса

curl -X GET \ 
--location 'https://core.feennex.com/check_status' \

Нажмите на кнопку ниже, чтобы просмотреть параметры метода и тела запроса и ответа.

GET Запросить доступность сервиса [GET]

Request

            {
                https://core.feennex.com/check_status
            }

Response 200 ()
- Body
```
        {
            "status": "OK"
        }
```
- Attributes (object)
- status: ОК (string, required) - Статус доступности сервиса

Регистрация пользователей по API [/account/register]

Вы можете создавать аĸĸаунты для ваших пользователей в Feennex с помощью API. Созданные аĸĸаунты будут иметь настройĸи, ĸоторые задал менеджер.

К сведению!

Для отправки запросов вам нужно выполнить все шаги по подключению

Каĸ это работает

Для создания аĸĸаунта вам нужно отправить POST-запрос в Feennex. В запросе передайте почту пользователя и идентифиĸатор вашего магазина.

К СВЕДЕНИЮ: Актуальный адрес для отправки запросов вам предоставит менеджер.

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

POST Пример запроса [POST]

Request

curl https://core.feennex.com/account/register
-H 'Content-Type: application/json'
-d '

        {
            "now": "2025-05-22 15:05:02",
            "shop_id": "1234",
            "email": "[email protected]",
            "sign": "c438896efecd63"
    }'
    + Body
    {
      "now": "2025-05-22 15:05:02",
      "shop_id": "1234",
      "email": "[email protected]",
      "sign": "c438896efecd63"
    }

Response 200 (application/json)

Body

    {
  "data": {
      "account_number": 8000000001,
      "email": "[email protected]"
  },
  "detailed_msg": null,
  "error_code": 0,
  "message": "Ok",
  "result": true
}

Response 200 Пример ответа при ошибке, когда пользователь уже существует

data (object, required) - Объект содержит данные о созданном аккаунте account_number: 8000000001 (number, optional) - Уникальный номер кошелька пользователя в Feennex. Возвращается, если аккаунт уже существовал email: [email protected] (string, required) - Электронная почта пользователя message: wallet already exists (string, optional) - Сообщение о результате регистрации. Возвращается при ошибке detailed_msg: null (string, optional) - Детализированное сообщение об ошибке error_code: 0 (number, required) - Код ошибки. Возможные значения кодов ошибок message: Ok (string, required) - Описание ошибки result: true (boolean, required) - Успешность запроса.

Group Методы для работы с магазином​

Запрос баланса shop_balance [/shop_balance]​

Запросить баланс [POST]​

Получение доступных платежных направлений shop_input_config/shop [/shop_input_config/shop]​

POST Получить доступные платежные направления [POST]​

Получение доступных направлений для выплат shop_output_config/shop [/shop_output_config/shop]​

POST Получить доступные направления для выплат [POST]​

Запрос доступности сервиса Feennex check_status [/check_status]​

GET Запросить доступность сервиса [GET]​

Регистрация пользователей по API [/account/register]​

POST Пример запроса [POST]​

Group Методы для работы с магазином

Запрос баланса shop_balance [/shop_balance]

Запросить баланс [POST]

Получение доступных платежных направлений shop_input_config/shop [/shop_input_config/shop]

POST Получить доступные платежные направления [POST]

Получение доступных направлений для выплат shop_output_config/shop [/shop_output_config/shop]

POST Получить доступные направления для выплат [POST]

Запрос доступности сервиса Feennex check_status [/check_status]

GET Запросить доступность сервиса [GET]

Регистрация пользователей по API [/account/register]

POST Пример запроса [POST]