Виплата на рахунок у сторонній платіжній системі

Group Виплата на рахунок у сторонній платіжній системі

Перед інтеграцією ознайомтеся з розділом Початок роботи з 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: \d15$ (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) - Электронная почта получателя выплаты. Не участвует в формировании подписи
  - 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]