Виплата на гаманець Feennex

Group Виплата на гаманець Feennex

Перед інтеграцією ознайомтеся з розділом Початок роботи з API

Попередній розрахунок виплати на гаманець Feennex transfer/try [/transfer/try]

Метод не обов'язковий для створення виплати на гаманець. Повертає додаткову інформацію для створення виплати на гаманець з попереднім розрахунком комісії.

Для методу потрібно сформувати підпис за допомогою обов'язкових параметрів запиту: amount, amount_type, payee_currency, shop_currency і shop_id. Сформований підпис потрібно передати в параметрі sign.

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

Приклад запиту

curl https://core.feennex.com/transfer/try \
   -H 'Content-Type: application/json' \
   -d '{
          "amount": 1.11,
          "amount_type": "receive_amount",
          "payee_currency": 978,
          "shop_currency": 840,
          "shop_id": 6,
          "sign": "cea33ec0eeeef98"
       }'

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

POST Попередній розрахунок виплати [POST]

Request (application/json)
- Attributes
  - amount: 1 (number, required) - Сумма получения или списания, зависит от значения amount_type
  - amount_type: receive_amount (string, required) - Определяет тип суммы. receive_amount – сумма выплаты, которая поступит на кошелек, writeoff_amount - сумма, которая спишется с баланса вашего магазина
  - payee_currency: 840 (string, required) - Валюта, в которой выплата поступит на кошелек Feennex. Возможные значения валют
  - shop_currency: 840 (number, required) - Валюта, с которой выплата спишется со счета вашего магазина. Возможные значения валют
  - shop_id: 1 (number, required) - Идентификатор вашего магазина, с которого проходит выплата
  - sign: cea33ec0eeeef98 (string, required) - Подпись запроса
- Body
```
{
   "amount": 1.11,
   "amount_type": "receive_amount",
   "payee_currency": 978,
   "shop_currency": 840,
   "shop_id": 6,
   "sign": "cea33ec0eeeef98"
}
```
Response 200 (application/json)
- Headers
- Body
```
{
    "data": {
        "account_info_config": {
            "payee_account": {
                "comment": {
                    "en": "Enter Wallet Number or Email",
                    "ru": "Введите номер кошелька или email"
                },
                "example": "201557414711",
                "label": {
                    "en": "Wallet Number or Email",
                    "ru": "Введите номер кошелька или email"
                },
                "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}$"
            }
        },
        "info": {},
        "payee_amount": 1.11,
        "payee_currency": 978,
        "shop_currency": 840,
        "write_off_amount": 1.19
    },
    "error_code": 0,
    "message": "Ok",
    "result": true
}   
```
- Attributes (object)
  - data (object, required) - Объект содержит информацию о выплате
    - account_info_config (object, required) - Информация об аккаунте, на который будет выплата
      - payee_account (object, required) - Дополнительная информация об аккаунте, на который будет выплата. Параметры в объекте могут отличаться для каждого направления на выплату
    - info (object, required) - Служебный параметр
    - payee_amount: 1.11 (number, required) - Сумма, которая поступит на ваш счет
    - payee_currency: 978 (number, required) - Валюта суммы, которая поступит на ваш счет
    - shop_currency: 840 (number, required) - Валюта суммы, которая спишется со счета вашего магазина
    - write_off_amount (number, required) - Сумма, которая спишется со счета магазина
  - error_code: 0 (number, required) - Код ошибки. Возможные значения кодов ошибок
  - message: Ok (string, required) - Описание ошибки. По значению этого параметра можно определить успешность запроса и узнать, что пошло не так
  - result: true (boolean, required) - Успешность запроса

Виплата на гаманець Feennex transfer/create [/transfer/create]

За допомогою цього методу ви можете створити виплату для переказу грошей з балансу магазину на ваш гаманець Feennex.

Важливо! Після створення виплати на гаманець у відповіді не повертається статус. Якщо виплата на гаманець створена, а у відповіді повернувся ідентифікатор виплати (параметр id), то виплата вважається успішною. Більше нічого робити не потрібно.

Для методу потрібно сформувати підпис за допомогою обов'язкових параметрів запиту: amount, amount_type, payee_account, payee_currency, shop_currency, shop_id і shop_payment_id. Сформований підпис потрібно передати в параметрі sign.

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

Приклад запиту

curl https://core.feennex.com/transfer/create \
   -H 'Content-Type: application/json' \
   -d '{
          "amount": 10,
          "amount_type": "receive_amount",
          "payee_account": "201497141132",
          "payee_currency": 840,
          "shop_currency": 840,
          "shop_id": 112,
          "shop_payment_id": "55ac443d-958b-40e3-8956-e04e72561324",
          "sign": "cd30ba2b6e29f5"
       }'

Детальніше про виплати на гаманець Feennex

Метод не є обов'язковим для створення виплати на гаманець. Повертає додаткову інформацію для створення виплати на гаманець з попереднім розрахунком комісії.

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

Створення виплати на гаманець [POST]

Request (application/json)
- Headers
- Attributes
  - amount: 1 (number, required) - Сумма получения или списания. Зависит от параметра amount_type
  - amount_type: receive_amount (string, required) - Определяет тип суммы. Возможные значения: receive_amount – сумма, которая поступит на ваш аккаунт с учетом всех комиссий. writeoff_amount - сумма, которая спишется с баланса магазина. Не включает в себя комиссию
  - payee_account: 201497141132 (string, required) - Аккаунт получателя денег в Feennex. Можно передать номер кошелька или email
  - payee_currency: 840 (string, required) - Валюта, в которой выплата поступит на аккаунт в Feennex. Возможные значения валют
  - shop_currency: 840 (number, required) - Валюта, в которой выплата спишется с вашего магазина. Возможные значения валют
  - shop_id: 1 (number, required) - Идентификатор вашего магазина, с которого осуществляется выплата
  - shop_payment_id (string, required) - Идентификатор выплаты на вашей стороне. Должен быть уникальным для каждой новой выплаты.
  - sign: cd30ba2b6e29f5 (string, required) - Подпись запроса
- Body
```
{
    "amount": 10,
    "amount_type": "receive_amount",
    "payee_account": "201497141132",
    "payee_currency": 840,
    "shop_currency": 840,
    "shop_id": 112,
    "shop_payment_id": "55ac443d-958b-40e3-8956-e04e72561324",
    "sign": "cd30ba2b6e29f5"
}
```
Response 200 ()
- Body
```
{
    "data": {
        "balance": 88.91,
        "id": 12,
        "payee_account": 201497141132,
        "payee_amount": 10,
        "payee_currency": 840,
        "shop": 112,
        "shop_currency": 840,
        "write_off_amount": 10
    },
    "error_code": 0,
    "message": "Ok",
    "result": true
}
```
- Attributes (object)
  - data (object, required) - Объект содержит данные о выплате
    - balance: 88.91 (number, required) - Баланс вашего магазина после выплаты
    - id (number, required) - Уникальный идентификатор выплаты
    - payee_account: 201497141132 (number, required) - Аккаунт получателя денег в системе Feennex. Можно передать номер кошелька или email
    - payee_currency: 840 (number, required) - Валюта, в которой выплата поступит на кошелек
    - shop: 112 (number, required) - Идентификатор магазина Feennex
    - shop_currency (number, required) - Валюта, в которой выплата спишется со счета вашего магазина
    - write_off_amount (number, required) - Сумма, которая спишется со счета магазина
  - error_code: 0 (number, required) - Код ошибки. Возможные значения кодов ошибок
  - message: Ok (string, required) - Описание ошибки. По значению этого параметра можно определить успешность запроса и узнать, что пошло не так
  - result: true (boolean, required) - Успешность запроса

Запит статусу виплати на гаманець transfer/shop_payment_status [/transfer/shop_payment_status]

Якщо під час створення виплати на гаманець ви отримали помилку у відповіді, запишіть статус виплати. Метод повертає статус виплати на гаманець Feennex за номером замовлення на вашому боці:

Якщо у відповіді повертається id і дані по переказу, виплата створена і успішно проведена.
Якщо повертається помилка, що виплата не знайдена, то потрібно повторно створити виплату на гаманець.

Для методу потрібно сформувати підпис за допомогою обов'язкових параметрів запиту: now, shop_id і shop_order_id. Сформований підпис потрібно передати в параметрі sign.

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

Приклад запиту

curl https://core.feennex.com/shop_payment_status \
   -H 'Content-Type: application/json' \
   -d '{
          "shop_id": 112, 
          "shop_payment_id": "55ac443d-958b-40e3-8956-e04e72561322", 
          "now": "2024-12-06 16:07:28.878200", 
          "sign": "e76c5ed9431d"
       }'

Приклад відповіді, якщо виплата створена і успішно проведена

{
  "data": {
    "id": 3,
    "payee_currency": 840,
    "receive_amount": 1,
    "shop_currency": 840,
    "shop_payment_id": "55ac443d-958b-40e3-8956-e04e72561322",
    "write_off_amount": 1
  },
  "error_code": 0,
  "message": "Ok",
  "result": true
}

Приклад відповіді при помилці

{ 
    "data": null, 
    "error_code": 7, 
    "message": "Transfer (shop_payment_id=test) wasn't found", 
    "result": false 
} 

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

Запитати статус виплати на гаманець [POST]

Headers
Content-Type: application/json
Request (application/json)
- Attributes
  - now (string, required) - Дата и время, когда вы отправляете запрос. Формат: ISO 8601
  - shop_id: 1 (number, required) - Идентификатор вашего магазина, с которого осуществляется выплата
  - shop_payment_id (string, required) - Идентификатор выплаты на вашей стороне. Должен быть уникальным для каждой новой выплаты.
  - sign: cd30ba2b6e29f5 (string, required) - Подпись запроса
- Body
```
{ 
    "shop_id": 112, 
    "shop_payment_id": "55ac443d-958b-40e3-8956-e04e72561322", 
    "now": "2024-12-06 16:07:28.878200", 
    "sign": "e76c5ed9431d" 
} 
```
Response 200 ()
- Body
```
{ 
    "data": 
        { 
            "id": 3, 
            "payee_currency": 840, 
            "receive_amount": 1, 
            "shop_currency": 840, 
            "shop_payment_id": "55ac443d-958b-40e3-8956-e04e72561322", 
            "write_off_amount": 1 
        }, 
        "error_code": 0, 
        "message": "Ok", 
        "result": true 
}  
```
- Attributes (object)
  - data (object, required) - Объект содержит данные о выплате
    - id (number, required) - Идентификатор выплаты
    - payee_currency: 840 (number, required) - Валюта выплаты, которая поступит на ваш кошелек
    - receive_amount: 1 (number, required) – Сумма, которая поступит на ваш кошелек
    - shop_currency: 840 (number, required) - Валюта, в которой выплата спишется со счета вашего магазина
    - shop_payment_id (string, required) - Уникальный идентификатор платежа на стороне вашего магазина;
    - write_off_amount (number, required) - Сумма списания с магазина. ВАлюта этой суммы соответствует значению параметра shop_currency
  - error_code: 0 (number, required) - Код ошибки. Возможные значения кодов ошибок
  - message: Ok (string, required) - Описание ошибки. По значению этого параметра можно определить успешность запроса и узнать, что пошло не так
  - result: true (boolean, required) - Успешность запроса

Group Виплата на гаманець Feennex​

Попередній розрахунок виплати на гаманець Feennex transfer/try [/transfer/try]​

POST Попередній розрахунок виплати [POST]​

Виплата на гаманець Feennex transfer/create [/transfer/create]​

Створення виплати на гаманець [POST]​

Запит статусу виплати на гаманець transfer/shop_payment_status [/transfer/shop_payment_status]​

Запитати статус виплати на гаманець [POST]​

Group Виплата на гаманець Feennex

Попередній розрахунок виплати на гаманець Feennex transfer/try [/transfer/try]

POST Попередній розрахунок виплати [POST]

Виплата на гаманець Feennex transfer/create [/transfer/create]

Створення виплати на гаманець [POST]

Запит статусу виплати на гаманець transfer/shop_payment_status [/transfer/shop_payment_status]

Запитати статус виплати на гаманець [POST]