Выплата на счет в сторонней платежной системе

Group Выплата на счет в сторонней платежной системе

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

Предварительный расчет выплаты withdraw/try [/withdraw/try]

Метод не обязательный. Возвращает дополнительную информацию для создания выплаты с предварительным расчетом комиссии.

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

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

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

curl https://core.feennex.com/withdraw/try \
   -H 'Content-Type: application/json' \
   -d '{
   
          "amount_type": "ps_amount", 
          "shop_currency": 840,
          "sign": "32b2c32caa8ad",
          "payway": "card_usd",
          "amount": 1,
          "shop_id": 112 
       }'

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

Запросить расчет выплаты [POST]

Request (application/json)
- Headers
- Attributes
  - shop_currency: 840 (number, required) - Валюта списания выплаты со счета вашего магазина. Возможные значения валют
  - amount_type: receive_amount (string, required) - Определяет тип суммы. Возможные значения: ps_amount – сумма, которая поступит на счет получателя в платежной системе, shop_amount – сумма, которая спишется с баланса вашего магазина
  - sign: 32b2c32caa8ad (string, required) - Подпись запроса
  - payway: card_usd (string, required) - Направление для выплаты. Возможные значения вы можете узнать в личном кабинете в настройках магазина в разделе Направления вывода. Валюта получения зависит от переданного направления для выплаты
  - amount: 1 (number, required) - Сумма получения или списания. Зависит от значения параметра amount_type
  - shop_id: 1 (number, required) - Идентификатор вашего магазина, с которого осуществляется выплата
- Body
```
    { 
        "amount_type": "ps_amount", 
        "shop_currency": 840,
        "sign": "f97c52fa8d273a",
        "payway": "card_usd",
        "amount": 1,
        "shop_id": 112 
    } 
```
Response 200 ()
- Body
```
    { 
    "data": 
        { 
            "account_info_config"
            {
                "account": 
                {
                    "regex": "\\d{9,15}$",
                    "title": "79123456789"
                }
            }
```
"payee_receive": 1, "ps_currency": 840, "shop_currency": 840, "shop_write_off": 1.02 }, "error_code": 0, "message": "Ok", "result": true }
- Attributes (object)
  - data (object, required) - Объект содержит данные о выплате
    - account_info_config (object, required) - Информация об аккаунте, на который будет выплата
      - account (object, required) - Дополнительная информация об аккаунте, на который будет выплата. Параметры в объекте могут отличаться для каждого направления на выплату
      - regex: \d{9,15}$ (string, required) - Регулярное выражение, которому должен соответствовать аккаунт
      - title: 79123456789 (string, required) - Название поля аккаунта
    - payee_receive: 1 (number, required) - Сумма выплаты, которая поступит на счет получателя в сторонней системе
    - ps_currency: 840 (number, required) - Валюта направления на выплату
    - shop_currency (number, required) - Валюта, в которой выплата спишется со счета магазина
    - write_off_amount (number, required) - Сумма списания с магазина в валюте кошелька
  - error_code: 0 (number, required) - Код ошибки. Возможные значения кодов ошибок
  - message: Ok (string, required) - Описание ошибки. По значению этого параметра можно определить успешность запроса и узнать, что пошло не так
  - result: true (boolean, required) - Успешность запроса

Проверка аккаунта check_account [/check_account]

Метод возвращает информацию о том, можно ли сделать выплаты на определенный аккаунт Feennex. Метод не обязательный для создания выплаты, но его рекомендуется использовать перед созданием выплаты.

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

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

Если в ответе на запрос Предварительный расчет выплаты возвращается объект account_info_config с дополнительными параметрами, эти параметры, кроме account, вам нужно передавать в запросе на Создание выплаты в параметре account_details.

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

curl https://core.feennex.com/check_account \
   -H 'Content-Type: application/json' \
   -d '{
          "account": "4111111111111111",
          "account_details": {
              "contract": "C1234"
          },
          "sign": "faf7ee6db712752f2b107e05328bbd0d",
          "payway": "card_eur",
          "amount": 10.5,
          "shop_id": 1
       }'

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

Запросить проверку [POST]

Request (application/json)
- Headers
- Attributes
  - account: 4111111111111111 (string, required) - Основной аккаунт, который нужно проверить на возможность пополнения. Формат для каждого платежного направления может отличаться: информацию можно уточнить в личном кабинете
  - account_details (object, optional) - Дополнительная информация для проверки аккаунта
    - contract: C1234 (string, optional) - Номер договора аккаунта, который нужно проверить на возможность пополнения
  - sign: 32b2c32caa8ad (string, required) - Подпись запроса
  - payway: card_usd (string, required) - Направление для выплаты. Возможные значения вы можете узнать в личном кабинете в настройках магазина в разделе Направления вывода. Валюта получения зависит от переданного направления для выплаты
  - amount: 1 (number, required) - Сумма планируемого зачисления на аккаунт в валюте платежного направления. Нужно для проверки лимитов пополнения
  - shop_id: 1 (number, required) - Идентификатор вашего магазина, с которого осуществляется выплата
- Body
```
    {
        "account": "4111111111111111",
        "account_details": {
            "contract": "C1234"
        },
        "sign": "faf7ee6db712752f2b107e05328bbd0d",
        "payway": "card_eur",
        "amount": 10.5,
        "shop_id": 1
    }
```
Response 200 ()
- Body
```
    {
        "data": {
            "account_info": {
                "verified": "true"
            },
            "provider_status": 1,
            "result": true
        },
        "error_code": 0,
        "message": "Ok",
        "result": true
    }
```
- Attributes (object)
  - data (object, required) - Объект содержит данные о проверке
    - account_info (object, required) - дополнительная информация, возвращаемая от провайдера услуги, можно отображать плательщику, так как зачастую содержит его персональную информацию, например, ФИО владельца аккаунта
      - verified: true (boolean, required) -
    - provider_status: 1 (number, required) - статус ответа провайдера, на запрос проверки возможности пополнения аккаунта, формат: 1 - провайдер доступен, проверка прошла без ошибок; 2 - ошибка на провайдере, результат проверки неизвестен; 3 - ошибка при обработке запроса, результат проверки неизвестен;
    - result: true (boolean, required) - результат проверки возможности пополнения на аккаунт
  - error_code: 0 (number, required) - Код ошибки. Возможные значения кодов ошибок
  - message: Ok (string, required) - Описание ошибки. По значению этого параметра можно определить успешность запроса и узнать, что пошло не так
  - result: true (boolean, required) - Успешность запроса

Создание выплаты withdraw/create [/withdraw/create]

Метод создает выплату для перечисления денег с баланса вашего магазина Feennex на доступные платежные системы, кроме кошелька Feennex.

Для метода нужно сформировать подпись с помощью обязательных параметров запроса: account, amount, amount_type, email, payway, shop_currency, shop_id и shop_payment_id. Сформированную подпись нужно передать в параметре sign.

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

Параметр shop_payment_id должен быть уникальным для каждого запроса.

Причину отклонения выплаты вы можете найти в параметре rejected_reason, который возвращается в запросах на создание выплаты и получение статуса выплаты

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

curl https://core.feennex.com/withdraw/create \
   -H 'Content-Type: application/json' \
   -d '{
          "account": "4111111111111111",
          "amount": 1,
          "amount_type": "ps_amount",
          "email": "[email protected]",
          "payway": "card_usd",
          "shop_currency": 840,
          "shop_id": 112,
          "shop_payment_id": "63288d86-241c-418e-94b8-db4bbf5026f",
          "sign": "b4c3ca4b403bb"
       }'

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

POST Создать выплату [POST]

Request (application/json)
- Headers
- Attributes
  - account: 4111111111111111 (string, required) - Аккаунт получателя выплаты в платежной системе, например номер карты
  - amount: 1 (number, required) - Сумма получения или списания. Зависит от значения параметра amount_type
  - amount_type: ps_amount (string, required) - Определяет тип суммы. Возможные значения: ps_amount – сумма к получению в платежной системе, shop_amount – сумма к списанию с баланса вашего магазина
  - email: [email protected] (string, required) - Электронная почта получателя выплаты. Не участвует в [формировании подписи(#sign)
  - payway: card_usd (string, required) - Направление для выплаты. Возможные значения вы можете узнать в личном кабинете в настройках магазина в разделе Направления вывода. Валюта получения зависит от переданного направления для выплаты
  - shop_currency: 840 (number, required) - Валюта, в которой выплата спишется со счета вашего магазина. Возможные значения валют
  - shop_id: 1 (number, required) - Идентификатор вашего магазина, с которого осуществляется выплата
  - shop_payment_id (string, required) - Уникальный идентификатор выплаты на вашей стороне
  - sign: 32b2c32caa8ad (string, required) - Подпись запроса
  - account_details (object, optional) - Объект с дополнительной информацией об аккаунте получателя выплаты. Состав параметров в объекте зависит от выбранного направления для выплат. Список параметров можно посмотреть в личном кабинете по каждому направлению
  - description: Выплата (string, optional) - Описание выплаты. Значение передается в назначении платежа, если платежная система имеет такую функцию. Не более 255 символов
- Body
```
    {
        "account": "4111111111111111",
        "amount": 1,
        "amount_type": "ps_amount",
        "email": "[email protected]",
        "payway": "card_usd",
        "shop_currency": 840,
        "shop_id": 112,
        "shop_payment_id": "63288d86-241c-418e-94b8-db4bbf5026f",
        "sign": "b4c3ca4b403bb" 
    }
```
Response 200 ()
- Body
```
    {
      "data": 
        {
            "balance": 0.0, 
            "id": 11298076, 
            "payee_receive": 1, 
            "ps_currency": 840, 
            "shop_currency": 840, 
            "shop_payment_id": "63288d86-241c-418e-94b8-db4bbf5026f", 
            "shop_write_off": 1.02, 
            "status": 3
         }, 
        "error_code": 0, 
        "message": "Ok", 
        "result": true
    } 
```
- Attributes (object)
  - data (object, required) - Объект содержит данные о выплате
    - balance: 0.0 (number, required) - Баланс вашего магазина после успешного создания выплаты
    - id: 11298076 (number, required) - Уникальный идентификатор выплаты на стороне Feennex
    - payee_receive: 1 (number, required) - Сумма выплаты, которая поступит на счет получателя в сторонней системе
    - shop_currency: 840 (number, required) - Валюта, в которой выплата спишется со счета вашего магазина
    - shop_payment_id (string, required) - Уникальный идентификатор выплаты на вашей стороне
    - shop_write_off: 1.02 (number, required) - Cумма, которая спишется с вашего магазина
    - status: 3 (number, required) - Статус выплаты
  - error_code: 0 (number, required) - Код ошибки. Возможные значения кодов ошибок
  - message: Ok (string, required) - Описание ошибки. По значению этого параметра можно определить успешность запроса и узнать, что пошло не так
  - result: true (boolean, required) - Успешность запроса

Запрос статуса по идентификатору выплаты withdraw/status [/withdraw/status]

Метод позволяет получить статус выплаты по идентификатору выплаты – параметру withdraw_id.

Рекомендуется запрашивать статус выплаты не чаще, чем раз в минуту.

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

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

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

curl https://core.feennex.com/withdraw/status \
   -H 'Content-Type: application/json' \
   -d '{
          "now": "2024-12-06 16:07:28.878200",
          "shop_id": 112,
          "withdraw_id": 11298076,
          "sign": "e1dfc97b2c5430"
       }'

Пример ответа при ошибке

{
  "error_code": 2000,
  "message": "Withdraw (id=3) wasn't found",
  "data": null,
  "result": false
}

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

POST Запросить статус выплаты [POST]

Request (application/json)
- Headers
- Attributes
  - now (string, required) - Дата и время, когда вы отправляете запрос. Формат: ISO 8601
  - shop_id: 1 (number, required) - Идентификатор вашего магазина, с которого осуществляется выплата
  - withdraw_id: 112 (number, required) - Уникальные идентификатор выплаты на стороне Feennex, для которой необходимо узнать статус
  - sign: 32b2c32caa8ad (string, required) - Подпись запроса
- Body
```
    {
        "now": "2024-12-06 16:07:28.878200",
        "shop_id": 112,
        "withdraw_id": 11298076,
        "sign": "e1dfc97b2c5430" 
    } 
```
Response 200 ()
- Body
```
    {
         "data": {
            "id": 11298076,
            "payee_receive": 1,
            "ps_currency": 840,
            "shop_currency": 840,
            "shop_payment_id": "63288d86-241c-418e-94b8-db4bbf5026f",
            "shop_write_off": 1.02,
            "status": 5
        }, 
        "result": True,
        "error_code": 0, 
        "message": "Ok"
    }
```
- Attributes (object)
  - data (object, required) - Объект содержит данные о выплате
    - id: 11298076 (number, required) - Уникальный идентификатор выплаты на стороне Feennex
    - payee_receive: 1 (number, required) - Сумма выплаты, которая поступит на счет получателя в сторонней системе
    - ps_currency: 840 (number, required) - Валюта получения выплаты в платежной системе
    - rejected_reason: Номер карты не существует. Пожалуйста, проверьте правильность номера (string, optional) - Причина отмены выплаты
    - shop_currency: 840 (number, required) - Валюта, в которой выплата спишется со счета вашего магазина
    - shop_payment_id (string, required) - Уникальный идентификатор выплаты на вашей стороне
    - shop_write_off: 1.02 (number, required) - Сумма списания с вашего магазина
    - status: 5 (number, required) - Статус выплаты. Возможные значения статусов
  - error_code: 0 (number, required) - Код ошибки. Возможные значения кодов ошибок
  - message: Ok (string, required) - Описание ошибки. По значению этого параметра можно определить успешность запроса и узнать, что пошло не так
  - result: true (boolean, required) - Успешность запроса

Запрос статуса по номеру выплаты в вашей системе withdraw/shop_payment_status [/withdraw/shop_payment_status]

Метод позволяет получить статус выплаты по номеру выплаты в вашей системе – параметру shop_payment_id.

Рекомендуется запрашивать статус выплаты не чаще, чем раз в минуту.

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

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

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

curl https://core.feennex.com/withdraw/shop_payment_status \
   -H 'Content-Type: application/json' \
   -d '{
          "shop_id":112,
          "shop_payment_id": "63288d86-241c-418e-94b8-db4bbf5026f",
          "now": "2024-12-06 16:07:28.878200",
          "sign": "a1ab593500a4"
       }'

Пример ответа при ошибке

{
    "error_code": 2000, 
    "message": "Withdraw (id=3) wasn't found", 
    "data": None, 
    "result": False
}

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

POST Запросить статус выплаты по идентификатору выплаты в вашей системе [POST]

Request (application/json)
- Headers
- Attributes
  - shop_id: 1 (number, required) - Идентификатор вашего магазина, с которого проходит выплата
  - shop_payment_id (string, required) - Уникальный номер выплаты на вашей стороне
  - now (string, required) - Дата и время, когда вы отправляете запрос. Формат: ISO 8601
  - sign: 32b2c32caa8ad (string, required) - Подпись запроса
- Body
```
    {
         "shop_id":112,
         "shop_payment_id": "63288d86-241c-418e-94b8-db4bbf5026f",
         "now": "2024-12-06 16:07:28.878200",
         "sign": "a1ab593500a4"
    } 
```
Response 200 ()
- Body
```
    {
         "data": {
            "id": 11298076,
            "payee_receive": 1,
            "ps_currency": 840,
            "shop_currency": 840,
            "shop_payment_id": "63288d86-241c-418e-94b8-db4bbf5026f",
            "shop_write_off": 1.02,
            "status": 5
        }, 
        "result": True,
        "error_code": 0, 
        "message": "Ok"
    }
```
- Attributes (object)
  - data (object, required) - Объект содержит данные о выплате
    - id: 11298076 (number, required) - Уникальный идентификатор выплаты на стороне Feennex
    - payee_receive: 1 (number, required) - Сумма выплаты, которая поступит на счет получателя в сторонней системе
    - ps_currency: 840 (number, required) - Валюта выплаты в платежной системе
    - shop_currency: 840 (number, required) - Валюта, в которой выплата спишется со счета вашего магазина
    - shop_payment_id (string, required) - Уникальный номер выплаты на вашей стороне
    - shop_write_off: 1.02 (number, required) - Сумма списания со счета вашего магазина
    - status: 5 (number, required) - Актуальный статус выплаты. Возможные значения статусов
  - error_code: 0 (number, required) - Код ошибки. Возможные значения кодов ошибок
  - message: Ok (string, required) - Описание ошибки. По значению этого параметра можно определить успешность запроса и узнать, что пошло не так
  - result: true (boolean, required) - Успешность запроса

Group Выплата на счет в сторонней платежной системе​

Предварительный расчет выплаты withdraw/try [/withdraw/try]​

Запросить расчет выплаты [POST]​

Проверка аккаунта check_account [/check_account]​

Запросить проверку [POST]​

Создание выплаты withdraw/create [/withdraw/create]​

POST Создать выплату [POST]​

Запрос статуса по идентификатору выплаты withdraw/status [/withdraw/status]​

POST Запросить статус выплаты [POST]​

Запрос статуса по номеру выплаты в вашей системе withdraw/shop_payment_status [/withdraw/shop_payment_status]​

POST Запросить статус выплаты по идентификатору выплаты в вашей системе [POST]​

Group Выплата на счет в сторонней платежной системе

Предварительный расчет выплаты withdraw/try [/withdraw/try]

Запросить расчет выплаты [POST]

Проверка аккаунта check_account [/check_account]

Запросить проверку [POST]

Создание выплаты withdraw/create [/withdraw/create]

POST Создать выплату [POST]

Запрос статуса по идентификатору выплаты withdraw/status [/withdraw/status]

POST Запросить статус выплаты [POST]

Запрос статуса по номеру выплаты в вашей системе withdraw/shop_payment_status [/withdraw/shop_payment_status]

POST Запросить статус выплаты по идентификатору выплаты в вашей системе [POST]