Payout to Feennex Wallet

Group Payout to Feennex Wallet

Before integration, please read the Get started with API section.

Precalculate payout to Feennex Wallet [/transfer/try]

This endpoint is optional for creating a payout to Feennex Wallet. It returns additional information for creating a payout to the wallet with a preliminary calculation of the commission.

To use this method, you need to generate a signature using the required request parameters: amount, amount_type, payee_currency, shop_currency, and shop_id. The generated signature must be passed in the sign parameter.

Click the button at the end of the method description to view the request and response parameter details.

Example request

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"
       }'

Click the button below to view the endpoint parameters and request/response bodies.

POST Precalculate payout [POST]

Request (application/json)
- Attributes
  - amount: 1 (number, required) - Amount to receive or debit, depending on the amount_type parameter
  - amount_type: receive_amount (string, required) - Parameter determines the type of amount. receive_amount - the amount of the payout that will be credited to the wallet, writeoff_amount - the amount that will be debited from your shop's balance
  - payee_currency: 840 (string, required) - Currency in which the payout will be credited to Feennex Wallet. Possible currency values
  - shop_currency: 840 (number, required) - Currency from which the payout will be debited from your shop's account. Possible currency values
  - shop_id: 1 (number, required) - Your shop's identifier from which the payout is made
  - sign: cea33ec0eeeef98 (string, required) - Request signature
- 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) - Information about the payout
  - account_info_config (object, required) - Information about an account to which the payout will be made
    - payee_account (object, required) - Additional information about the account to which the payout will be made. Parameters in the object may vary for each payout direction
  - info (object, required) - Service parameter
  - payee_amount: 1.11 (number, required) - Amount that will be credited to your account
  - payee_currency: 978 (number, required) - Currency of the amount that will be credited to your account
  - shop_currency: 840 (number, required) - Currency of the amount that will be debited from your shop's account
  - write_off_amount (number, required) - Amount that will be debited from the shop's account
- error_code: 0 (number, required) - Error code. Possible error codes
- message: Ok (string, required) - Error description. Based on the value of this parameter, you can determine the success of the request and find out what went wrong
- result: true (boolean, required) - Success of the request

Create payout to Feennex Wallet [/transfer/create]

Use this endpoint tp create a payout to transfer money from your shop balance to Feennex Wallet.

Important! Once a payout is created, no status is returned the response. If a payout is created to the wallet and the payout ID (id parameter) is returned in the response, then the payment is considered successful.

To use this method, you need to generate a signature using the required request parameters: amount, amount_type, payee_account, payee_currency, shop_currency, shop_id, and shop_payment_id. The generated signature must be passed in the sign parameter.

Click the button at the end of the method description to view the request and response parameter details.

Example request

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"
       }'

More about payouts to Feennex Wallet

The endpoint isn't mandatory for creating a payout to the wallet. It returns additional information for creating a payout to the wallet with a preliminary commission calculation.

Click the button below to view the endpoint parameters and request/response bodies.

Create payout to Feennex Wallet [POST]

Request (application/json)
- Headers
- Attributes
  - amount: 1 (number, required) - Amount to receive or debit, depending on the amount_type parameter
  - amount_type: receive_amount (string, required) - Defines the type of amount. Possible values: receive_amount - the amount that will be received to your account including all commissions. writeoff_amount - the amount that will be debited from the shop balance. Doesn't include commissions
  - payee_account: 201497141132 (string, required) - Account of the recipient of money in Feennex. Wallet number or email
  - payee_currency: 840 (string, required) - Currency in which the payout will be received by the Feennex account. Possible currency values
  - shop_currency: 840 (number, required) - Currency in which the payout will be debited from your shop. Possible currency values
  - shop_id: 1 (number, required) - Identifier of your shop from which the payout will be debited
  - shop_payment_id (string, required) - Number of the payout on your side. Must be unique for each new payment
  - sign: cd30ba2b6e29f5 (string, required) - Request signature
- 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) - Payment data
    - balance: 88.91 (number, required) - Balance of your shop after payment
    - id (number, required) - Unique payment identifier
    - payee_account: 201497141132 (number, required) - Payee account in Feennex system. You can pass your wallet number or email
    - payee_currency: 840 (number, required) - Currency in which the payment will be received on the wallet
    - shop: 112 (number, required) - ID of Feennex shop
    - shop_currency (number, required) - Currency in which the payment will be debited from your shop's account
    - write_off_amount (number, required) - The amount that will be debited from your shop's account
  - error_code: 0 (number, required) - Error code. Possible error codes
  - message: Ok (string, required) - Error description. By the value of this parameter you can determine the success of the request and find out what went wrong
  - result: true (boolean, required) - Success of the request

Request status of payout to wallet [/transfer/shop_payment_status]

If you received an error in the response when creating payout to Wallet, request the status of the payout. The endpoint returns the status of the payout to Feennex Wallet by the order number on your side:

If the response returns id and transfer details, the payout has been created and successfully completed.
If an error is returned that the payout wasn't found, you need to recreate payout to Wallet.

To use this method, you need to generate a signature using the required request parameters: now, shop_id, and shop_order_id. The generated signature must be passed in the sign parameter.

Click the button at the end of the method description to view the request and response parameter details.

Example request

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": "2018-01-23 16:45:14.145107", 
          "sign": "e76c5ed9431d"
       }'

Response example if a payment is created and successfully made

{
  "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
}

Example of an error response

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

Click the button below to view the endpoint parameters and request/response bodies.

Request status of payout to wallet [POST]

Headers
Content-Type: application/json
Request (application/json)
- Attributes
  - now (string, required) - The date and time when you send the request. Format: ISO 8601
  - shop_id: 1 (number, required) - The identifier of your store from which the payout is made
  - shop_payment_id (string, required) - The payout identifier on your side. Must be unique for each new payout.
  - sign: cd30ba2b6e29f5 (string, required) - The request signature
- Body
```
{ 
    "shop_id": 112, 
    "shop_payment_id": "55ac443d-958b-40e3-8956-e04e72561322", 
    "now": "2024-01-23 16:45:14.145107", 
    "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) - Payment data
    - id (number, required) - Payment identifier
    - payee_currency: 840 (number, required) - Currency of the payout that will be credited to your wallet
    - receive_amount: 1 (number, required) - Amount that will be credited to your wallet
    - shop_currency: 840 (number, required) - Currency in which the payment will be debited from your shop account
    - shop_payment_id (string, required) - Unique identifier of the payment on the side of your shop
    - write_off_amount (number, required) - Amount of debit from the shop. The currency of this amount corresponds to the value of the shop_currency parameter
  - error_code: 0 (number, required) - Error code. Possible values of error codes
  - message: Ok (string, required) - Error description. By the value of this parameter you can determine the success of the request and find out what went wrong
  - result: true (boolean, required) - Success of the request

Group Payout to Feennex Wallet​

Precalculate payout to Feennex Wallet [/transfer/try]​

POST Precalculate payout [POST]​

Create payout to Feennex Wallet [/transfer/create]​

Create payout to Feennex Wallet [POST]​

Request status of payout to wallet [/transfer/shop_payment_status]​

Request status of payout to wallet [POST]​

Group Payout to Feennex Wallet

Precalculate payout to Feennex Wallet [/transfer/try]

POST Precalculate payout [POST]

Create payout to Feennex Wallet [/transfer/create]

Create payout to Feennex Wallet [POST]

Request status of payout to wallet [/transfer/shop_payment_status]

Request status of payout to wallet [POST]