Group Interaction with the shop
Before integration, please read the Get started with API section.
Request shop balance [/shop_balance]
Use this endpoint to check the balance of your Feennex shop.
To use this method, you need to generate a signature using the required request parameters: now 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.
The shop balance consists of the following values:
available– The amount available for payouts, excluding therolling_reservefrozen– A frozen amount on the balance. For example, for a payout that is being processedhold– A temporarily held amount. For example, during the verification of an incoming payment
Request example
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"
}'
Click the button below to view the endpoint parameters and request/response bodies.
Request shop balance [POST]
-
Request (application/json)
-
Headers
-
Attributes
- shop_id: 1 (number, required) - Identifier of your shop, from which the payment is made
- shop_payment_id (string, optional) - Identifier of the transaction on the shop side
- now (string, required) - Date and time when you send the request. Format: ISO 8601
- sign: 32b2c32caa8ad (string, required) - Request signature
-
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": 643,
"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) - Balance information
- balances (array, required) - shop balance by currencies
- object
- available: 93.0 (number, required) - Available balance of the shop
- currency: 840 (number, required) - Balance currency. Possible currency values
- hold: 0.0 (number, required) - Temporarily withheld funds, for example, when checking an incoming receipt.
- frozen: 20.0 (number, required) - Frozen funds in the shop’s balance
- rolling_reserve 0.0 (number, optional) - Temporarily held funds in the shop’s balance
- object
- shop_id: 112 (number, required) - Identifier of your Feennex shop
- balances (array, required) - shop balance by currencies
- 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
- data (object, required) - Balance information
-
Request available payment directions [/shop_input_config/shop]
The endpoint returns available payment directions for your shop. For example, payment by bank card or Feennex Wallet.
To use this method, you need to generate a signature using the required request parameters: now 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/shop_input_config/shop \
-H 'Content-Type: application/json' \
-d '{
"shop_id":112,
"now": "2024-04-12T06:18:34.719Z",
"sign": "77c6cc948751ee"
}'
Click the button below to view the endpoint parameters and request/response bodies.
POST Request available payment directions [POST]
-
Request (application/json)
-
Headers
-
Attributes
- now (string, required) - Date and time when you send the request. Format: ISO 8601
- shop_id: 112 (number, required) - Identifier of the shop from which the payment is made
- sign: 32b2c32caa8ad (string, required) - Signature of the request
-
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_rub",
"currency": 643,
"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) - Available payment directions data
- object
- id: 3 (number, required) - Payment method identifier
- is_bill_config (boolean, optional) - Parameter that indicates that the direction is intended for payments
- name: MIR (string, required) - Name of payment method
- payways (array, required) - Payment directions that are enabled for the shop
- object
- add_ons_config (string, optional) - Additional information, if required for the payment direction
- alias: card_usd (string, required) - Name of payment direction
- currency: 840 (number, required) - Currency by payment direction. Possible currency values
- fee_config (object) - Settings of commission distribution between the shop and the payer.
- fix: 0.0 (number, required) - Fixed fee
- percent: 6.0 (number, required) - Percentage commission distribution (0,0-1,0)
- fee_part_config (object, optional) - ???? settings of commission distribution between shop and payer
- fix: 0.0 (number, required) - fixed commission????
- percent: 6.0 (number, required) - ????percentage commission????
- id: 154 (number, required) - Id of payment direction
- is_active: true (boolean, required) - Activation status
- max_amount: 100000.0 (number, required) - Maximum amount of payment by direction
- min_amount: 1.0 (number, required) - Minimum payment amount by direction
- object
- rating (number, optional) - Service parameter
- object
- 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
- data (object, required) - Available payment directions data
-
Request available payout directions [/shop_output_config/shop]
The endpoint returns the available payment destinations for your shop. For example, payment to a bank card.
To use this method, you need to generate a signature using the required request parameters: now 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/shop_output_config/shop \
-H 'Content-Type: application/json' \
-d '{
"shop_id":3,
"now": "03.09.2024 11:19:55",
"sign": "588485c9d7f0d"
}'
Click the button below to view the endpoint parameters and request/response bodies.
POST Request available payout directions [POST]
-
Request (application/json)
-
Headers
-
Attributes
- now (string, required) - Date and time when you send the request. Format: ISO 8601
- shop_id: 1 (number, required) - Identifier of your shop, from which the payment is made
- sign: 32b2c32caa8ad (string, required) - Signature of the request
-
Body
{
"now": "03.09.2024 11:19:55",
"shop_id": 3,
"sign": "588485c9d7f0d"
}
-
-
Response 200 ()
-
Body
{
"data":[
{
"id": 1,
"name": "MIR",
"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) - Data on available payment destinations
- id: 3 (number, required) - Payment method identifier
- is_transfer_config (boolean, optional) - Parameter that indicates that the direction is intended for payments.
- name: MIR (string, required) - Name of payment method
- payways (array, required) - Directions for payments that are connected for your shop
- object
- account_info_config (object) - Information about an account to which the payout will be made
- account (object) - Additional account information
- regex (string, required) - Regular expression to which the account must match
- title (string, required) - Name of the account field
- account (object) - Additional account information
- account_info_config (object) - Information about an account to which the payout will be made
- alias: card_rub (string, required) - Name of payment direction
- currency: 643 (number, required) - Currency by payment direction. Possible currency values
- fee_config (object) - Fee amount
- fix: 0.0 (number, required) - fixed fee
- percent: 6.0 (number, required) - percentage fee
- info_id: null (string, required) - Service parameter
- max_amount: 10000.0 (number, required) - Maximum payment amount by direction
- min_amount: 0.5 (number, required) - Minimum payment amount by direction
- object
- rating: 22 (number, required) - Service parameter
- 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
- data (object, required) - Data on available payment destinations
-
Request Feennex service availability [/check_status]
Use this endpoint to check the availability of Feennex service.
Example request
curl -X GET \
--location 'https://core.feennex.com/check_status' \
Click the button below to view the endpoint parameters and request/response bodies.
GET Request Feennex service availability [GET]
-
Headers
-
Content-Type: application/json
-
Request
{
https://core.feennex.com/check_status
} -
Response 200 ()
-
Body
{
"status": "OK"
} -
Attributes (object)
- status: OK (string, required) - Status of service availability
-