REST_API

Usage Of The inCust Terminal API

General information
Authorization
2.1 Authorize using login and password
2.2 Authorize using API KEY
Receive Terminal settings
Receive customer categories
Receive customer accounts
Receive goods and categories
Receive customer data
7.1 Receive customer identifier from inCust Kiosk
7.2 Receive customer questionnaire
7.3 Change customer questionnaire
7.4 Change customer's access type
7.5 Change customer's category
7.6 Customer's consent to processing of personal data
Receive loyalty program rules
Operations with check
9.1 Check preparation
9.2 Check processing
9.3 Save check with finalization
9.4 Save check
9.5 Reserve check
9.6 Finalize check
9.7 Create and finalize check
9.8 Reserve funds for check
9.9 Processing of check with previously reserved funds
9.10 Write off previously reserved funds
Payments
10.1 Query payments by check
10.2 Add payment to check
10.2 Cancel payment by check
10.4 Send information about payment to app for customers
10.5 Retrieve payment status
Transactions
11.1 Transaction object
11.1 Receive list of transactions
11.2 Cancel transaction
11.3 Receive information about transaction
11.4 Receive check of transaction
Code of order
12.1 Generate code of order
12.2 Retrieve code of latest order, generated by Temrinal
Customer identifiers
13.1 Search for customers by identifiers
13.2 Register customer with specified identifiers
13.3 Retrieve customer identifiers
13.4 Add customer identifiers
13.5 Remove customer identifiers
Coupons
14.1 Issue coupons of series
14.2 Retrieve coupon data
14.3 Use coupon without customer
14.4 Get list of coupons, added to customer's wallet
14.5 Add coupon to customer wallet
14.6 Ust coupon of "certificate" type
Benefits
15.1 Crediting of customer account
Tourist card (prepaid services card)
16.1 List of customer's tourist cards
16.2 Add tourist card to customer's wallet
16.3 Retrieval of data about tourist card
16.4 Use of service from tourist card
Store
17.1 List of customer's orders
17.2 List of orders
17.3 Retrieval of information about order
17.4 Change of order status
Jobs
18.1 Job object
18.2 Query jobs by check
18.3 Create job and link it to check
18.4 Create job
18.5 Obtain information about job
18.6 Start job
18.7 Stop job
18.8 Link existing job to check
Fuel and energy
19.1 Detailed information about state of fuel pump or charging station
Goods and categories in brand
20.1 Retrieve goods list
20.2 Create goods
20.3 Retrieve goods categories list
20.4 Create goods category
20.5 Obtain information about goods category
20.6 Change goods category
20.7 Add or change goods category image
20.8 Retrieve goods by code
20.9 Retrieve goods by ID
20.10 Change goods
20.11 Activate/deactivate goods
20.12 Add supplementary goods image
20.13 Delete supplementary goods image
20.14 Add main goods image
20.15 Add recommended values for goods
20.16 Add price list for goods
Additional functions
21.1 Confirmation of customer's phone number
Response codes

General information

Exchange of information with the API server is performed in JSON format

Server URL: https://api.incust.com/v1

In the header of any request, the following fields should be present:

Content-Type, set to application/json
Accept-Language, set to one of the possible values (supported languages) 'en' - english, 'ru' - russian, 'uk' - ukrainian, 'pl' - polish, 'sk' - slovak.

Authorization

To use the Terminal API, you need to use the authorization token, which should be added to the header of all requests.

The token can be short-term, when it is obtained using the login and password, and long-term, when it is obtained via the API KEY.

Before you get to authorization, you need to add at least one Terminal to the list of Terminals in the Business Control Panel. The login and password as well as the API key of one of the added Terminals will be used for authenticating API requests.

To work with the Terminal API using the login and password, one needs to receive an authorization token. This token is to be added to the header of all requests. The login and password should match the values set for one of the Terminals which you have added in the Business Control Panel.

Request for authorization token

URL: /term/token
Method: POST
URL parameters:
- no
Data parameters:
- login, type: string,
- password, type: string

Sample request:

  { 
     "method":"POST",
     "url":"https://api.incust.com/v1/term/token",
     "headers":{ 
        "Content-Type":"application/json",
        "Accept-Language":"en"
     },
     "data": {"login":"login","password":"1234"}
  }

Sample response:

  { 
     "business_code":"123456",
     "currency":"USD",
     "display_active":1,
     "display_type":"customer-identity",
     "id":"02ba6bea-ecf3-11e5-a83a-020000ed147d",
     "loyalty":{ 
        "title":"Pizza Hattta"
     },
     "phone":"+14321111111",
     "pos":{ 
        "addresses":"First avenu",
        "country":"US",
        "title":"Point Of Sale name"
     },
     "title":"Terminal name",
     "token":"eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6IjAyYmE2YmVhLWVjZjMtMTFlNS1hODNhLTAyMDAwMGVkMTQ3ZCJ9.C5gyNg.HwPVfsPdcDR1GX3kHnQ6e1EcnpQ"
  }

Remarks:
In the case of a well-formed request and correct data, the response contains the token and common information about the business, POS and Terminal.
You need to save the token in order to add it to headers of all subsequent requests and refresh the token at least once a day. Token's lifetime is 24 hours.

Authorization using API KEY

To authenticate requests to the Terminal API, you can use API KEY instead of the token. You can enable authentication with an API KEY in the Business Control Panel - use the API KEY button near the name of the Terminal entry, which you want to use for API operations.

The format of the Authorization field in the header is the same as in the case of a token, obtained using a login and password:
"Authorization":"bearer eyJ0ZXJtaW5hbF9pZCI6IjAyYmE2YmVhLWVjZjMtMTFlNS1hODNhLTAyMDAwMGVkMTQ3ZCIsInZlcnNpb24iOjF9.C5rXRQ.FVbaHN0go0FK3EbWIXtEg9AvNbg"

Advantages of the API KEY authorization method:

API KEY lifetime is 10 years, you don't need to refresh it as you do with a token.
An API KEY will stop working only when you explicitly refresh it in the Control Panel. The need to do this arises only for security reasons (the key has been compromised etc.)

Receiving Terminal settings

Request for retrieval of Terminal settings

URL: /term/settings
Method: GET
URL parameters:
- no
Data parameters:
- no

Sample request:

  {
     "method":"GET",
     "url":"https://api.incust.com/v1/term/settings",
     "headers":{
        "Content-Type":"application/json",
        "Authorization":"bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6IjAyYmE2YmVhLWVjZjMtMTFlNS1hODNhLTAyMDAwMGVkMTQ3ZCJ9.C7UthA.wvYZuI-vrJymIlEI15EHdT7kcIY"
     }
  }

Sample response:

  {
     "business_code":"305187",
     "currency":"USD",
     "display_active":0,
     "display_type":"customer-identity",
     "id":"02ba6bea-ecf3-11e5-a83a-020000ed147d",
     "loyalty":{
        "title":"My Loyalty program"
     },
     "loyalty_settings":{
        "bonus_payment_limit":30,
        "bonus_payment_type":"partial"
     },
     "phone":"+12401234567",
     "pos":{
        "addresses":"Point of sale coordinates",
        "country":"US",
        "title":"My Cool Shop"
     },
     "system_params": {
        "default_check_amount_decimal_digits": 2,
        "default_check_bonuses_decimal_digits": 2,
        "default_check_special_accounts_decimal_digits": 2,
        "default_item_amount_decimal_digits": 2,
        "default_item_bonuses_decimal_digits": 2,
        "default_item_price_decimal_digits": 3,
        "default_item_special_accounts_decimal_digits": 2,
        "maximum_check_amount_decimal_digits": 2,
        "maximum_check_bonuses_decimal_digits": 2,
        "maximum_check_special_accounts_decimal_digits": 2,
        "maximum_item_amount_decimal_digits": 2,
        "maximum_item_bonuses_decimal_digits": 2,
        "maximum_item_price_decimal_digits": 2,
        "maximum_item_special_accounts_decimal_digits": 2,
        "support_external_id_primary_identifier": true
     },
     "title":"Main inCust Terminal"
  }

Remarks:
In the case of a well-formed request, the response contains the object with data and Terminal settings:
- id: identifier of the Terminal
- phone: phone number, connected to the Terminal
- title: Terminal name
- business_code: A unique code of the business, consists of 6 digits
- currency: Terminal currency (ISO 4217)
- display_active: specifies whether Kiosk is connected to the Terminal (0 – no, 1 – yes)
- display_type: Kiosk mode, possible values:
  - customer-identity - customer authentification
  - gift-redeem - selection and redeeming of rewards
- loyalty: loyalty program data
  - title: Loyalty program title
- loyalty_settings: loyalty program settings
  - bonus_payment_limit: Restriction on payment with bonus points. The value is set as a percentage of the amount due (amount_to_pay) of the check.
  - bonus_payment_type: Type of payment with bonus points, possible values
    - partial: partial payment
    - partial-rounded: partial payment with rounding to the whole
    - full-check: only full payment of the check
- pos: Point Of Sale data
  - addresses: an address which is specified in the Point Of Sale settings
  - country: country code which is specified in the settings
  - title: Point of Sale name
- system_params: system parameters
  - maximum_check_amount_decimal_digits: maximal number of decimal digits in a check sum
  - default_check_amount_decimal_digits: default number of decimal digits in a check sum
  - maximum_check_bonuses_decimal_digits: maximal number of decimal digits in the sum of bonus points, credited or redeemed within a check
  - default_check_bonuses_decimal_digits: default number of decimal digits in the sum of bonus points, credited or redeemed within a check
  - maximum_check_special_accounts_decimal_digits: maximal number of decimal digits in the sums credited to customer accounts within a check
  - default_check_special_accounts_decimal_digits: default number of decimal digits in the sums credited to customer accounts within a check
  - maximum_item_price_decimal_digits: maximal number of decimal digits in the goods price
  - default_item_price_decimal_digits: default number of decimal digits in the goods price
  - maximum_item_amount_decimal_digits: maximal number of decimal digits in the goods sum
  - default_item_amount_decimal_digits: default number of decimal digits in the goods sum
  - maximum_item_bonuses_decimal_digits: maximal number of decimal digits in the sum of bonus points, credited or redeemed by goods position
  - default_item_bonuses_decimal_digits: default number of decimal digits in the sum of bonus points, credited or redeemed by goods position
  - maximum_item_special_accounts_decimal_digits: maximal number of decimal digits in the sums credited to customer accounts by goods position
  - default_item_special_accounts_decimal_digits: default number of decimal digits in the sums credited to customer accounts by goods position
  - support_external_id_primary_identifier: indicator of support of an external identifier as a main customer or user identifier in the system

Receive customer categories

To change a customer's category, it is necessary to load the list of available categories.

Request for receiving customer categories

URL: /term/card_categories
Method: GET
URL parameters:
- no
Data parameters:
- no

Sample request:

  {
     "method":"GET",
     "url":"https://api.incust.com/v1/term/card_categories",
     "headers":{
        "Content-Type":"application/json",
        "Accept-Language":"en",
        "Authorization":"bearer eyJ0ZXJtaW5hbF9pZCI6IjAyYmE2YmVhLWVjZjMtMTFlNS1hODNhLTAyMDAwMGVkMTQ3ZCIsInZlcnNpb24iOjF9.C5rXRQ.FVbaHN0go0FK3EbWIXtEg9AvNbg"
     }
  }

Sample response:

  [
     {
        "id": "5c5e9012-ee35-4863-8ec2-3a12e51d6c2f",
        "title": "Test PLATINUM",
        "type": "custom"
     },
     {
        "id": "9806a813-e396-4c5c-bb0a-4e44b3e50628",
        "title": "Test GOLD",
        "type": "custom"
     },
     {
        "id": "b4e2d095-0d35-11e6-bfd1-020000ed147d",
        "title": "NEW CUSTOMERS",
        "type": "base"
     }
  ]

Remarks:
In the case of a well-formed request and correct data, the response includes an array that contains a list of customer categories. Each element of the array is an object that has the following fields:
- id: category ID
- title: category title
- type: category type. Possible values: 'base', 'custom'

Receiving of customer accounts

In order to work with customer accounts (provision of a free cup of coffee after buying seven cups, getting prepaid volume of fuel, etc.) in the inCust Terminal, you must retrieve accounts, available to the Terminal. If you don't expect to work with accounts, you can skip this step and go directly to the receiving of goods and categories

Request for receiving customer accounts

URL: /term/special_account
Method: GET
URL parameters:
- no
Data parameters:
- no

Sample request:

  {
     "method":"GET",
     "url":"https://api.incust.com/v1/term/special_account",
     "headers":{
        "Content-Type":"application/json",
        "Accept-Language":"en",
        "Authorization":"bearer eyJ0ZXJtaW5hbF9pZCI6IjAyYmE2YmVhLWVjZjMtMTFlNS1hODNhLTAyMDAwMGVkMTQ3ZCIsInZlcnNpb24iOjF9.C5rXRQ.FVbaHN0go0FK3EbWIXtEg9AvNbg"
     }
  }

Sample response:

  [
     {
        "active":1,
        "goods_items":[
           "1444"
        ],
        "id":"23116258-bffd-4b8c-9c42-a3d8c4a941bd",
        "public_title":"Prepayment for coffee",
        "title":"Prepayment for coffee",
        "type":"goods",
        "unconfirmed_redeem_amount":0
     },
     {
        "active":1,
        "goods_items":[
           "123",
           "1234"
        ],
        "id":"2d1d3ae9-eb45-43f8-87ff-12987f5d3ffa",
        "public_title":"Universal fuel account",
        "title":"Universal fuel account",
        "type":"goods",
        "unconfirmed_redeem_amount":0
     },
     {
        "active":1,
        "id":"4adaa00d-fd86-415b-86a7-e75709b5dc11",
        "public_title":"Achievements",
        "title":"Achievements",
        "type":"punches",
        "unconfirmed_redeem_amount":0
     },
     {
        "active":1,
        "goods_items":[
           "1234"
        ],
        "id":"4b43be56-c667-4057-8ee3-fcbd179ac6df",
        "public_title":"Diesel fuel",
        "title":"DF",
        "type":"goods",
        "unconfirmed_redeem_amount":0
     },
     {
        "active":1,
        "id":"c785aa00-d288-4384-814e-f33fc074c7b2",
        "public_title":"Reward for the visit",
        "title":"Reward for the visit",
        "type":"punches",
        "unconfirmed_redeem_amount":0
     },
     {
        "active":1,
        "goods_items":[
           "123"
        ],
        "id":"fe16758d-6fe1-45b7-9781-dbd94b77c4ee",
        "public_title":"Premium Unleaded",
        "title":"Premium gasoline",
        "type":"goods",
        "unconfirmed_redeem_amount":0
     }
  ]

Remarks:
In the case of a well-formed request and correct data, the response includes an array that contains a list of customer accounts. Each element of the array is an object that has the following fields:
- id: customer account id
- active: is the account enabled (1 – yes, 0 – no)
- public_title: localized account name
- title: account name
- type: account type. Possible values are 'punches', 'goods', 'money'
- goods_items: array of goods' codes (code of the goods item), which may be sold from this account (goods filter).
  - For the account with the type == 'goods', if no goods are specified (the array is empty or omitted), you can't sell anything from such an account.
  - For other types of accounts, if no goods are specified (the array is empty or omitted), any goods can be sold.
- unconfirmed_redeem_amount: The amount of units, allowed to be redeemed from the account without confirming the operation by SMS

Receiving goods and categories

After successful authorization, it is necessary to obtain a list of goods and categories of goods for conducting trading operations in the inCust Terminal.

Receiving a list of categories

URL: /term/categories
Method: GET
URL parameters:
- no
Data parameters:
- no

Sample request:

 { 
    "method":"GET",
    "url":"https://api.incust.com/v1/term/categories",
    "headers":{ 
       "Content-Type":"application/json",
       "Accept-Language":"en",
       "Authorization":"bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6IjAyYmE2YmVhLWVjZjMtMTFlNS1hODNhLTAyMDAwMGVkMTQ3ZCJ9.C5gyNg.HwPVfsPdcDR1GX3kHnQ6e1EcnpQ"
    }
 }

Sample response:

 [ 
    { 
       "active":1,
       "code":"Category of goods 1",
       "color":3545497855,
       "id":"38aa3c1c-21c5-4bf8-a25f-4df4043bfb3a",
       "title":"Category of goods 1",
       "image":{ 
          "id":"d47ee357-af5c-49d7-adad-e4e76649d2eb",
          "url":"https://api.incust.com/static/d7/85/cc792b8e4d4ca24de7ea53b5b745.jpeg"
       },
       "nodes":[ 
          { 
             "active":1,
             "code":"Subcategory of goods 1.1",
             "color":4294967295,
             "id":"acb18938-0393-4a95-9efd-8b61f0f1058d",
             "parent_id":"38aa3c1c-21c5-4bf8-a25f-4df4043bfb3a",
             "title":"Subcategory of goods 1.1"
          }
       ]
    },
    { 
       "active":1,
       "code":"Category of goods 2",
       "color":4294967295,
       "id":"4729488e-051a-4238-bebb-9d40306109b3",
       "title":"Category of goods 2"
    },
    { 
       "active":1,
       "code":"Category of goods 3",
       "color":4294967295,
       "id":"82daa2d8-774a-44df-a078-b26d41ed4290",
       "title":"Category of goods 3"
    }
 ]

Remarks:
In the case of a well-formed request and correct data, the response includes an array that contains a list of category of goods with which the inCust Terminal works. Each element of the array is an object that has the following fields:
- id: category id
- active: is category enabled (1 – yes, 0 – no)
- title: code / article title
- color: color of the category(integer)
- title: category title
- image: the object contains the following fields: id - Id of the image, url - link to the image
- nodes: An array contains child categories. The structure of array objects is the same as described above, each child object can also contain an array of nodes, etc.

Receiving the list of goods

URL: /term/goods
Method: GET
URL parameters:
- category
  - 'all' – returns all goods
  - 'root' – returns goods without categories
  - category_id – returns goods from categories
Data parameters:
- no

Sample request:

  {
     "method":"GET",
     "url":"https://api.incust.com/v1/term/goods?category=all",
     "headers":{
        "Content-Type":"application/json",
        "Accept-Language":"en",
        "Authorization":"bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6ImRmNGYzNzJmLWM0NzktNDNkMi1iNDRhLTg3MDZiZWEyY2EwOSJ9.C5g1YA.q6yWPEECM12jhAzphz2BOWNO8mg"
     }
  }

Sample response:

 [
    {
       "active":1,
       "code":"1444",
       "color":4294967295,
       "id":"1bd042be-2458-4612-9fca-f47ae7086fb6",
       "image":{
          "id":"5130ac00-f142-4ec1-a320-8bcaa1ff6ea8",
          "url":"https://api.incust.com/static/46/24/e3f3046640f79506021683de9a8a.jpeg"
       },
       "image_id":"5130ac00-f142-4ec1-a320-8bcaa1ff6ea8",
       "loyalty_id":"87f74cd0-b174-11e6-bfd1-020000ed147d",
       "parent_code":"Drinks",
       "parent_id":"3dfc0bd1-7052-4748-98f1-2f747f70a500",
       "parent_title":"Drinks",
       "price":[
          {
             "id":"86d70a06-7fb9-4ef5-b79d-a36a198ab9c9",
             "price":1,
             "special_account":{
                "active":1,
                "goods_items":[
                   "1444"
                ],
                "id":"23116258-bffd-4b8c-9c42-a3d8c4a941bd",
                "public_title":"Prepayment for coffee",
                "title":"Prepayment for coffee",
                "type":"goods",
                "unconfirmed_redeem_amount":0
             },
             "special_account_id":"23116258-bffd-4b8c-9c42-a3d8c4a941bd",
             "type":"special-account"
          },
          {
             "id":"98b78cdc-34a7-452a-8624-6f3bd069770c",
             "price":7,
             "special_account":{
                "active":1,
                "id":"c785aa00-d288-4384-814e-f33fc074c7b2",
                "public_title":"Reward for the visit",
                "title":"Reward for the visit",
                "type":"punches",
                "unconfirmed_redeem_amount":0
             },
             "special_account_id":"c785aa00-d288-4384-814e-f33fc074c7b2",
             "type":"special-account"
          },
          {
             "currency":"USD",
             "id":"154264aa-05ad-4d1d-8858-7101ddde451e",
             "price":10,
             "type":"currency"
          }
       ],
       "sort_order":0,
       "title":"Coffee",
       "unit":"piece",
       "variable_price":0,
       "variable_total":0,
       "weighing":0,
       "whole_number":1
    },
    {
       "active":1,
       "code":"11111",
       "color":4294967295,
       "id":"4ce153e5-8ed9-4840-bcd3-e0f77536e055",
       "image":{
          "id":"9d377a96-ee6e-4322-88a2-c56563131537",
          "url":"https://api.incust.com/static/b0/67/d83f371e4bc998896556f16970e7.jpeg"
       },
       "image_id":"9d377a96-ee6e-4322-88a2-c56563131537",
       "loyalty_id":"87f74cd0-b174-11e6-bfd1-020000ed147d",
       "parent_code":"Pizza",
       "parent_id":"a85f4142-2fe3-4806-9843-5229d4bcf938",
       "parent_title":"Pizza",
       "price":[
          {
             "id":"ec708edb-c334-43c1-b322-9f267c14748d",
             "price":20,
             "special_account":{
                "active":1,
                "id":"c785aa00-d288-4384-814e-f33fc074c7b2",
                "public_title":"Reward for the visit",
                "title":"Reward for the visit",
                "type":"punches",
                "unconfirmed_redeem_amount":0
             },
             "special_account_id":"c785aa00-d288-4384-814e-f33fc074c7b2",
             "type":"special-account"
          },
          {
             "currency":"USD",
             "id":"375f47d9-8338-4861-a7d1-d690d6c77203",
             "price":80,
             "type":"currency"
          }
       ],
       "sort_order":0,
       "title":"Pizza 5 seasons",
       "unit":"piece",
       "variable_price":0,
       "variable_total":0,
       "weighing":0,
       "whole_number":1
    },
    {
       "active":1,
       "code":"12344",
       "color":4294967295,
       "id":"5b6a423d-9a05-470c-a0c4-aaa0400433a8",
       "image":{
          "id":"ebced7ef-8b31-4aa9-859d-1492eef0db4c",
          "url":"https://api.incust.com/static/59/15/ec56e3964316a57ef51f90690cd1.jpeg"
       },
       "image_id":"ebced7ef-8b31-4aa9-859d-1492eef0db4c",
       "loyalty_id":"87f74cd0-b174-11e6-bfd1-020000ed147d",
       "parent_code":"Pizza",
       "parent_id":"a85f4142-2fe3-4806-9843-5229d4bcf938",
       "parent_title":"Pizza",
       "price":[
          {
             "id":"21185186-db47-409c-954c-24e1f1119152",
             "price":40,
             "special_account":{
                "active":1,
                "id":"c785aa00-d288-4384-814e-f33fc074c7b2",
                "public_title":"Reward for the visit",
                "title":"Reward for the visit",
                "type":"punches",
                "unconfirmed_redeem_amount":0
             },
             "special_account_id":"c785aa00-d288-4384-814e-f33fc074c7b2",
             "type":"special-account"
          },
          {
             "currency":"USD",
             "id":"e25d31df-9f2c-4a05-a7c6-637acc27e1af",
             "price":95,
             "type":"currency"
          }
       ],
       "sort_order":0,
       "title":"Pizza meat",
       "unit":"pc",
       "variable_price":0,
       "variable_total":0,
       "weighing":0,
       "whole_number":1
    },
    {
       "active":1,
       "code":"54321",
       "color":4294967295,
       "id":"880abda0-04c2-4779-a93d-92d5273ec5eb",
       "image":{
          "id":"9f0b02a7-fe61-420b-9ec5-016ccb66a0d8",
          "url":"https://api.incust.com/static/50/76/5c1b743f450aa3c4be7c7ab887d9.jpeg"
       },
       "image_id":"9f0b02a7-fe61-420b-9ec5-016ccb66a0d8",
       "loyalty_id":"87f74cd0-b174-11e6-bfd1-020000ed147d",
       "parent_code":"Drinks",
       "parent_id":"3dfc0bd1-7052-4748-98f1-2f747f70a500",
       "parent_title":"Drinks",
       "price":[
          {
             "id":"4c608c24-2a6b-4664-b409-b51ff4ffb170",
             "price":5,
             "special_account":{
                "active":1,
                "id":"c785aa00-d288-4384-814e-f33fc074c7b2",
                "public_title":"Reward for the visit",
                "title":"Reward for the visit",
                "type":"punches",
                "unconfirmed_redeem_amount":0
             },
             "special_account_id":"c785aa00-d288-4384-814e-f33fc074c7b2",
             "type":"special-account"
          },
          {
             "currency":"USD",
             "id":"fe535973-5236-4b7f-a515-747a4741030d",
             "price":25,
             "type":"currency"
          }
       ],
       "sort_order":0,
       "title":"Ginger tea",
       "unit":"piece",
       "variable_price":0,
       "variable_total":0,
       "weighing":0,
       "whole_number":1
    },
    {
       "active":1,
       "code":"3113",
       "color":4294967295,
       "id":"fbed57fb-207e-4b55-8da7-dae8e1896d84",
       "image":{
          "id":"90942b1b-295c-45c0-b081-49d67e0b70bc",
          "url":"https://api.incust.com/static/04/1b/e6235b1c420e950bd50908d8c844.jpeg"
       },
       "image_id":"90942b1b-295c-45c0-b081-49d67e0b70bc",
       "loyalty_id":"87f74cd0-b174-11e6-bfd1-020000ed147d",
       "parent_code":"Desserts",
       "parent_id":"e609f66f-9bd2-4352-8b71-bd3228774ff2",
       "parent_title":"Desserts",
       "price":[
          {
             "id":"71f4f14e-7038-4895-823b-5b22166620a9",
             "price":3,
             "special_account":{
                "active":1,
                "id":"c785aa00-d288-4384-814e-f33fc074c7b2",
                "public_title":"Reward for the visit",
                "title":"Reward for the visit",
                "type":"punches",
                "unconfirmed_redeem_amount":0
             },
             "special_account_id":"c785aa00-d288-4384-814e-f33fc074c7b2",
             "type":"special-account"
          },
          {
             "currency":"USD",
             "id":"b20975ab-ecda-4ee0-88f0-b6dbca51e1aa",
             "price":5,
             "type":"currency"
          }
       ],
       "sort_order":0,
       "title":"Dessert with blueberry",
       "unit":"piece",
       "variable_price":0,
       "variable_total":0,
       "weighing":0,
       "whole_number":1
    }
 ]

Remarks:
In the case of a well-formed request and correct data, the response includes an array that contains a list of goods with which the inCust Terminal works. Each element of the array is an object that has the following fields:
- id: good id
- code: good code or SKU
- active: is the good enabled (1 – yes, 0 – no)
- color: color of the good(integer)
- title: good title
- image:
  - id: image id
  - url: image url
- parent_title: parent category code / article
- parent_id: parent category id
- parent_title: parent category title
- price: array of prices for goods can contain two types of objects
  - the price of goods in the currency contains fields:
    - id: price id
    - type: price type, the value is equal currency
    - currency: the currency in which the price of the good is set
    - price: price of the good (integer)
  - Price for goods in the account of the customer
    - id: price id
    - type: price type, the value is equal special-account
    - price: price of the good (integer)
    - special_account_id: Customer account id
    - special_account: an object which contains information about special account
      - active: is the account enabled (1 – yes, 0 – no)
      - id: account id
      - public_title: localized account name
      - title: account name
      - type: account type. Possible values 'punches', 'goods', 'money'
      - unconfirmed_redeem_amount: The amount of redeemed units from the account without confirmation by SMS
      - goods_items: An array of codes(code of the good) of goods linked to the account, is present in the response only if type == 'goods'
- sort_order: sorting order of the goods
- unit: units of measurement of goods('kilograms;, 'grams', 'liters' and etc.)
- variable_price: variable price (1 – yes, 0 – no), means that the salesperson can enter the price of the goods instead of the one specified earlier in the control panel
- variable_total: variable amount of sales operation (1 – yes, 0 – no)
- weighing: sold by weight (1 – yes, 0 – no)
- whole_number: good is sold by bulk only. (1 – yes, 0 – no)

Receiving customer data

This method is necessary to obtain information about the customer: the number of bonus points on the account, the availability of funds in the accounts of the customer, the name, age data, etc.

Request for receiving customer data

URL:
- /term/cardinfo/{{id}}/{{id_type}}
- /term/cardinfo/{{id}} - simplified method without specifying the ID type; supports only the following ID types: phone number in international format ('+' at the beginning of the phone number is mandatory), plastic card number, code of the order ('@' at the beginning of the code is mandatory) or QR code from the inCust app.
Method: GET
URL parameters:
- id: customer ID. In the case of the simplified method, it can be only a phone number in international format ('+' at the beginning of the phone number is mandatory), plastic card number, code of the order ('@' at the beginning of the code is mandatory) or QR code from the inCust app
- id_type: the type of the customer ID. Currently, the following types are supported in the system:
  - phone - phone number in international format ('+' at the beginning of the phone number is mandatory)
  - qr - QR code from the inCust app
  - email - customer e-mail (the one used to login to inCust)
  - card - plastic card number
  - temporary-card - customer code, generated by the inCust Terminal app in Steward mode
  - id - customer ID in the inCust system
  - social-network - customer ID in the social network, with FB_ prefix for Facebook and G_ for Google
  - ssn - social security number for the US citizens and residents
  - itin - individual taxpayer's number
Data parameters:
- no

Sample request:

  {
     "method":"GET",
     "url":"https://api.incust.com/v1/term/cardinfo/+12401234567/phone",
     "headers":{
        "Content-Type":"application/json",
        "Accept-Language":"en",
        "Authorization":"bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6ImRmNGYzNzJmLWM0NzktNDNkMi1iNDRhLTg3MDZiZWEyY2EwOSJ9.C5q8aw.KasPpXo01yFhoqei_M02VOLF6Fk"
     }
  }

Example url for phone number https://api.incust.com/v1/term/cardinfo/123456
Example url for QR code https://api.incust.com/v1/term/cardinfo/1,+12401234567,1488530852,59EFCB1A2FE68D1865365BB8C38532527B61A19259F394

Sample response for a new customer (the one that never conducted transactions within the given business):

  {
     "bonuses":null,
     "coupons":null,
     "customer":{
        "access_type":"full-bonuses-access",
        "new":1,
        "show_questionnaire":1,
        "user_status":"active"
     },
     "rate_info":null,
     "specials":null
  }

Sample response if the customer is registered in the business:

  {
     "bonuses":[
        {
           "currency":"USD",
           "permanent_bonuses_amount":501.9,
           "temporary_bonuses_amount":0
        }
     ],
     "customer":{
        "access_type":"full-bonuses-access",
        "avatar":"https://api.incust.com/static/fe/c3/79e9a4c9416eb843b09d47dbd7da.jpeg",
        "last_sale_date":"2017-02-16T09:36:04Z",
        "new":0,
        "show_questionnaire":0,
        "user_birth_date":"1972-01-01",
        "user_created":"2016-10-24T06:33:18.498000Z",
        "user_gender":"male",
        "user_name":"Alex",
        "user_phone":"+12401234567",
        "user_status":"active"
     },
     "rate_info":{
        "currency":"USD",
        "turnover":6561
     },
     "specials":[
        {
           "amount":4,
           "id":"c785aa00-d288-4384-814e-f33fc074c7b2",
           "title":"Reward for the visit"
        }
     ],
      "coupons":[
         {
            "batch":{
               "business_id":"02b61320-ecf3-11e5-a83a-020000ed147d",
               "exchange_coupon_redeem_fee":0,
               "id":"3dc71a1f-1483-11e7-898a-020000ed147d",
               "image":"https://api.incust.com/static/13/87/5540302b42ea96fcfe833c43312a.jpeg",
               "loyalty_id":"02b6a028-ecf3-11e5-a83a-020000ed147d",
               "public_description":"Coupon batch description",
               "public_title":"Coupon batch title",
               "share_allowed":0,
               "type":"check-modifier"
            },
            "code":"246990359478",
            "id":"4081a81a-1483-11e7-898a-020000ed147d",
            "status":"open"
         },
         {
            "batch":{
               "business_id":"02b61320-ecf3-11e5-a83a-020000ed147d",
               "exchange_coupon_redeem_fee":0,
               "id":"17ec7187-3bd2-11e7-8cbf-020000ed147d",
               "loyalty_id":"02b6a028-ecf3-11e5-a83a-020000ed147d",
               "public_description":"Coupon batch description",
               "public_title":"Coupon batch title",
               "recommendation_fee_amount":1,
               "recommendation_fee_bonuses_currency":"USD",
               "recommendation_fee_promotional_bonuses_expire_date":"2017-06-19",
               "recommendation_fee_promotional_bonuses_expire_type":"date",
               "recommendation_fee_promotional_bonuses_expire_value":0,
               "recommendation_fee_type":"promotional-bonuses",
               "share_allowed":1,
               "type":"certificate"
            },
            "code":"192059545592",
            "id":"46884efe-4d1b-11e7-8cbf-020000ed147d",
            "status":"open"
         }
      ],
      "tourist_cards": [
          {
              "accounts": [
                  {
                      "amount": 0,
                      "id": "2a72c955-5bed-4988-802b-3841f92ca016",
                      "precision": "integer",
                      "public_title": "Account title"
                  }
              ],
              "activated_dt": "2018-06-20T09:57:47.225000Z",
              "active": 1,
              "code": "570237733572",
              "expire_dt": "2018-08-20T09:57:47.225000Z",
              "id": "609d58d7-7470-11e8-a7b9-020000ed147d",
              "public_title": "Card title",
              "public_description": "Card description",
              "services": [
                  {
                      "available_amount": 0,
                      "available_now": 0,
                      "available_times": 0,
                      "category": {
                          "id": "6a641932-5672-421f-aaec-9760bc8cf4fe",
                          "public_title": "Service category title"
                      },
                      "decrement_step": 5,
                      "id": "78c3f28f-bdbd-47df-9e11-e039e10f19ea",
                      "public_title": "Service title",
                      "public_description": "Service description",
                      "usage_limit_per_loyalty": 0,
                      "usage_limit_per_loyalty_period_type": "all-card-time",
                      "usage_limit_per_loyalty_period_value": 0,
                      "usage_limit_per_pos": 3,
                      "usage_limit_per_pos_period_type": "hour",
                      "usage_limit_per_pos_period_value": 1,
                      "used_times": 10
                  }
              ],
              "valid": 1
          }
      ]
  }

Remarks:
Depending on the type of identifier used to obtain the customer's card, responses will be different if the customer does not exist:
- phone number: The answer will always be positive. If the customer does not exist, empty data will be returned with the status set to new customer; if they exist, the customer data will be returned
- card number: If the card does not exist, an error will be returned. To fix this, you need to bind the card to an existing customer
- QR code: If the code has expired or the customer is not registered in this business, an error will be returned. To fix this, it is necessary to carry out a transaction through the Terminal at least once using the phone number, or create/import the customer in the Control Panel
The response to the request will contain the following fields:
- bonuses: An array of objects with customer's bonus points, each object will contain the following fields:
  - currency: bonus currency
  - permanent_bonuses_amount: the amount of permanent bonus points
  - temporary_bonuses_amount: the amount of temporary bonus points
- customer: an object contains the following fields:
  - access_type: access type, possible values are 'full-bonuses-access', 'add-bonuses-only', 'waiting-for-confirmation', 'in-black-list'
  - avatar: link to the customer's picture
  - last_sale_date: date of the last sale
  - new: whether the customer is new to the current business (1 - yes, 0 - no)
  - show_questionnaire: whether the dialog with the customer questionnaire should be shown to the cashier (1 - yes, 0 - no). The dialog lets the salesperson / cashier enter customer data into the system
  - user_birth_date: customer's date of birth
  - user_created: date of creation of the customer in the inCust system
  - user_gender: customer's gender
  - user_name: customer's name
  - user_phone: customer's phone number
  - user_status: customer's status, possible values 'active', 'suspended'
- rate_info: Contains information about the turnover:
  - turnover: customer's turnover for the whole period
- specials: an array of objects with customer accounts, each object will contain the following fields:
  - amount: Number of units in the customer's account
  - id: customer account Id
  - title: customer account name
- coupons: An array of objects with customer's coupons, each object will contain the following fields:
  - id: coupon id
  - code: coupon code
  - batch: object of the series of coupons, contains data on the series of coupons to which the coupon belongs, contains the following fields
    - id: id coupons series
    - type: coupon series type, possible values 'certificate', 'check-modifier'
    - public_title: public title of coupon series
    - public_description: public description of coupon series
    - image: Coupon series picture, a link to an image
  - status: coupon status, possible values 'open', 'redeemed', 'cancelled', In this case only coupons with status will be returned 'open'
    - For coupons of 'certificate' type with 'redeemed' status, the data about the benefits, credited when the coupon is redeemed, is returned:
  - redeemed_charge_type: the type of the credited benefits. The possible values are 'regular-bonuses' - bonus points, 'promotional-bonuses' - temporary bonus points, 'special-account' - customer account)
  - redeemed_charge_amount: the amount of credited benefits
  - redeemed_charge_bonuses_currency: currency of credited bonus points (ISO code)
  - redeemed_charge_expired: the expiration date of temporary bonus points in 'YYYY-MM-DD' format
  - redeemed_charge_special_account_id: customer account identifier
  - redeemed_charge_special_account_title: public name of the customer account
  - redeemed_charge_special_account_currency: currency of the customer account (ISO code)
- tourist_cards: arrray of tourist card objects with tourist cards of the customer.

Receiving customer identifier from inCust Kiosk

this method allows to get the customer ID from the Kiosk application and a one-time password (PIN) from the SMS, which is necessary for redeeming bonus points and charging customer accounts. Read more inCust Kiosk, customer self-service

Request for receiving the customer identifier from inCust Kiosk

URL: /term/display_customer
Method: GET
URL parameters:
- no
Data parameters:
- no

Sample request:

  {
      "method":"GET",
      "url":"https://api.incust.com/v1/term/display_customer",
      "headers":{
        "Content-Type":"application/json",
        "Accept-Language":"en",
        "Authorization":"bearer eyJ0ZXJtaW5hbF9pZCI6IjAyYmE2YmVhLWVjZjMtMTFlNS1hODNhLTAyMDAwMGVkMTQ3ZCIsInZlcnNpb24iOjF9.C5rXpQ.zZvP5SKGBACGo3W2-uYRmwSuXSs"
      }
  }

Sample response:

  {
      "cardotppassword":2173,
      "id":"+12401234567"
  }

Remarks:
In the case of a well-formed request, the response contains:
- blank object {}, if there is no customer in Kiosk.
- an object that contains the user id { "id":"+12401234567" }, if the customer has entered the phone number
- an object that contains the phone number in the customer id and the password from SMS { "id":"+12401234567", "cardotppassword":2173 } in cardotppassword, if the customer entered their phone number and confirmed it by entering the code from the SMS
- An object that contains a QR code in the customer id { "id":"1,+12401234567,1488530852,59EFCB1A2FE68D1865365BB8C38532527B61A19259F394" }, if the customer is authorized with the help of the inCust mobile app for customers
Subsequently, the received id should be used for receiving customer data, and added to the check object on the check processing stage. If cardotppassword is present in the response, it also needs to be added to the check object.

Receiving customer's questionnaire

This method allows to get customer's profile data which are stored in the platform.

Request for receiving customer's questionnaire

URL:
- /term/questionnaire/{{id}}/{{id_type}}
- /term/questionnaire/{{id}} - simplified method without specifying the ID type; supports only the following ID types: phone number in international format ('+' at the beginning of the phone number is mandatory), plastic card number, code of the order ('@' at the beginning of the code is mandatory) or QR code from the inCust app.
Method: GET
URL parameters:
- id: customer ID. In the case of the simplified method, it can be only a phone number in international format ('+' at the beginning of the phone number is mandatory), plastic card number, code of the order ('@' at the beginning of the code is mandatory) or QR code from the inCust app
- id_type: the type of the customer ID. Currently, the following types are supported in the system:
  - phone - phone number in international format ('+' at the beginning of the phone number is mandatory)
  - qr - QR code from the inCust app
  - email - customer e-mail (the one used to login to inCust)
  - card - plastic card number
  - temporary-card - customer code, generated by the inCust Terminal app in Steward mode
  - id - customer ID in the inCust system
  - social-network - customer ID in the social network, with FB_ prefix for Facebook and G_ for Google
  - ssn - social security number for the US citizens and residents
  - itin - individual taxpayer's number
Data parameters:
- no

Sample request:

  {
     "method":"GET",
     "url":"https://api.incust.com/v1/term/questionnaire/+12401234567/phone",
     "headers":{
        "Content-Type":"application/json",
        "Accept-Language":"en",
        "Authorization":"bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6IjAyYmE2YmVhLWVjZjMtMTFlNS1hODNhLTAyMDAwMGVkMTQ3ZCJ9.C7_mAg.KT2RcE4BwIFr8GXvTzVrzKXaODQ"
     }
  }

Sample response:

  {
     "customer":{
        "user_birth_date":"1963-01-29",
        "user_gender":"male",
        "user_name":"Username"
     },
     "fields":[
        {
           "description":"Last name",
           "id":"66c5e653-e71a-49ac-89f6-8a646e29843d",
           "sort_order":0,
           "type":"string",
           "value": "Last name"
        },
        {
           "description":"Have a child",
           "dictionary_values":[
              "Yes",
              "No"
           ],
           "id":"fc61fee6-2ed7-11e6-bfd1-020000ed147d",
           "sort_order":1,
           "type":"dictionary",
           "value":"No"
        },
        {
           "description":"Year salary",
           "id":"12739ce4-2754-48cd-a31f-a9ddf4c80ee3",
           "sort_order":3,
           "type":"integer",
           "value": 120000
        },
        {
           "description":"Memorial date",
           "id":"2ca456f7-772b-4ae7-9a9e-b172763d5d3a",
           "sort_order":4,
           "type":"date",
           "value":"2016-11-20T00:00:00Z"
        }
     ]
  }

Remarks:
In the case of a well-formed request, the response will contain two fields:
- customer customer's system fields:
  - user_name: customer's name in the inCust system
  - user_gender: customer's gender, possible values: male, female, other
  - user_birth_date: customer's birth date
- fields customizable user fields. The inCust platform allows to add custom fields to a user profile, the settings are available by link. Each custom field will be transferred as an object with the following fields:
  - id: field identifier
  - description: field name
  - sort_order: A number that determines the order of displaying the fields
  - type: field type, possible types:
    - string: text string
    - dictionary: dictionary, a set of fixed values
    - integer: numeric field
    - date: date
  - value: field value
  - dictionary_values: an array of the possible values of a dictionary is present in the response only if the field type (type) equals to dictionary

Changing customer's questionnaire

This method allows to update the data of the customer's questionnaire.

Request for changing the customer's questionnaire

URL:
- /term/questionnaire/{{id}}/{{id_type}}
- /term/questionnaire/{{id}} - simplified method without specifying the ID type; supports only the following ID types: phone number in international format ('+' at the beginning of the phone number is mandatory), plastic card number, code of the order ('@' at the beginning of the code is mandatory) or QR code from the inCust app.
Method: PATCH
URL parameters:
- id: customer ID. In the case of the simplified method, it can be only a phone number in international format ('+' at the beginning of the phone number is mandatory), plastic card number, code of the order ('@' at the beginning of the code is mandatory) or QR code from the inCust app
- id_type: the type of the customer ID. Currently, the following types are supported in the system:
  - phone - phone number in international format ('+' at the beginning of the phone number is mandatory)
  - qr - QR code from the inCust app
  - email - customer e-mail (the one used to login to inCust)
  - card - plastic card number
  - temporary-card - customer code, generated by the inCust Terminal app in Steward mode
  - id - customer ID in the inCust system
  - social-network - customer ID in the social network, with FB_ prefix for Facebook and G_ for Google
  - ssn - social security number for the US citizens and residents
  - itin - individual taxpayer's number
Data parameters:
- customer: Object customer, contains the following fields:
  - user_name: type 'string', customer's name
  - user_gender: type 'string', customer's gender, acceptable values: male, female, other
  - user_birth_date: type 'string', format YYYY-MM-DD, customer's birth date
- fields: customizable fields, contains key / value pairs
  - id: type 'string', custom field identifier.
  - value: type 'string', customizable field value.

Sample request:

  {
     "method":"PATCH",
     "url":"https://api.incust.com/v1/term/questionnaire/+12401234567/phone",
     "headers":{
        "Content-Type":"application/json",
        "Accept-Language":"en",
        "Authorization":"bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6IjAyYmE2YmVhLWVjZjMtMTFlNS1hODNhLTAyMDAwMGVkMTQ3ZCJ9.C7_mAg.KT2RcE4BwIFr8GXvTzVrzKXaODQ"
     },
     "data":{
        "customer":{
           "user_birth_date":"1963-01-29",
           "user_gender":"male",
           "user_name":"James"
        },
        "fields":{
           "66c5e653-e71a-49ac-89f6-8a646e29843d":null,
           "fc61fee6-2ed7-11e6-bfd1-020000ed147d":"No",
           "12739ce4-2754-48cd-a31f-a9ddf4c80ee3":null,
           "2ca456f7-772b-4ae7-9a9e-b172763d5d3a":"2016-11-19T02:00:00+02:00"
        }
     }
  }

Sample response:

  {
     "customer":{
        "user_birth_date":"1963-01-29",
        "user_gender":"male",
        "user_name":"Username"
     },
     "fields":[
        {
           "description":"Last name",
           "id":"66c5e653-e71a-49ac-89f6-8a646e29843d",
           "sort_order":0,
           "type":"string",
           "value": "Tailor"
        },
        {
           "description":"Have a child",
           "dictionary_values":[
              "Yes",
              "No"
           ],
           "id":"fc61fee6-2ed7-11e6-bfd1-020000ed147d",
           "sort_order":1,
           "type":"dictionary",
           "value":"No"
        },
        {
           "description":"Year salary",
           "id":"12739ce4-2754-48cd-a31f-a9ddf4c80ee3",
           "sort_order":3,
           "type":"integer",
           "value": 120000
        },
        {
           "description":"Memorial date",
           "id":"2ca456f7-772b-4ae7-9a9e-b172763d5d3a",
           "sort_order":4,
           "type":"date",
           "value":"2016-11-20T00:00:00Z"
        }
     ]
  }

Remarks:
In the case of a well-formed request, the response will contain the same object that GET method returns

Change customer's access type

This method allows to change the type of customer's access.

Request for changing the customer's access type

URL:
- /term/customers/{{id}}/{{id_type}}/access_type
- /term/customers/{{id}}/access_type - simplified method without specifying the ID type; supports only the following ID types: phone number in international format ('+' at the beginning of the phone number is mandatory), plastic card number, code of the order ('@' at the beginning of the code is mandatory) or QR code from the inCust app.
Method: PATCH
URL parameters:
- id: customer ID. In the case of the simplified method, it can be only a phone number in international format ('+' at the beginning of the phone number is mandatory), plastic card number, code of the order ('@' at the beginning of the code is mandatory) or QR code from the inCust app
- id_type: the type of the customer ID. Currently, the following types are supported in the system:
  - phone - phone number in international format ('+' at the beginning of the phone number is mandatory)
  - qr - QR code from the inCust app
  - email - customer e-mail (the one used to login to inCust)
  - card - plastic card number
  - temporary-card - customer code, generated by the inCust Terminal app in Steward mode
  - id - customer ID in the inCust system
  - social-network - customer ID in the social network, with FB_ prefix for Facebook and G_ for Google
  - ssn - social security number for the US citizens and residents
  - itin - individual taxpayer's number
Data parameters:
- access_type: type 'string', new access type

Sample request:

  {
     "method":"PATCH",
     "url":"https://api.incust.com/v1/term/customers/+12401234567/phone/access_type",
     "headers":{
        "Content-Type":"application/json",
        "Accept-Language":"en",
        "Authorization":"bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6IjAyYmE2YmVhLWVjZjMtMTFlNS1hODNhLTAyMDAwMGVkMTQ3ZCJ9.C7_mAg.KT2RcE4BwIFr8GXvTzVrzKXaODQ"
     },
     "data":{
         "access_type": "full-bonuses-access"
     }
  }

Sample response:

  {
    "access_type": "full-bonuses-access"
  }

Remarks:
In the case of a well-formed request, the response will contain the new access type

Change customer's category

This method allows to change the customer's category.

Request for changing the customer's category

URL:
- /term/customers/{{id}}/{{id_type}}/card_category
- /term/customers/{{id}}/card_category - simplified method without specifying the ID type; supports only the following ID types: phone number in international format ('+' at the beginning of the phone number is mandatory), plastic card number, code of the order ('@' at the beginning of the code is mandatory) or QR code from the inCust app.
Method: PATCH
URL parameters:
- id: customer ID. In the case of the simplified method, it can be only a phone number in international format ('+' at the beginning of the phone number is mandatory), plastic card number, code of the order ('@' at the beginning of the code is mandatory) or QR code from the inCust app
- id_type: the type of the customer ID. Currently, the following types are supported in the system:
  - phone - phone number in international format ('+' at the beginning of the phone number is mandatory)
  - qr - QR code from the inCust app
  - email - customer e-mail (the one used to login to inCust)
  - card - plastic card number
  - temporary-card - customer code, generated by the inCust Terminal app in Steward mode
  - id - customer ID in the inCust system
  - social-network - customer ID in the social network, with FB_ prefix for Facebook and G_ for Google
  - ssn - social security number for the US citizens and residents
  - itin - individual taxpayer's number
Data parameters:
- id: type 'string', identifier of the new category of the customer

Sample request:

  {
     "method":"PATCH",
     "url":"https://api.incust.com/v1/term/customers/+12401234567/phone/card_category",
     "headers":{
        "Content-Type":"application/json",
        "Accept-Language":"en",
        "Authorization":"bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6IjAyYmE2YmVhLWVjZjMtMTFlNS1hODNhLTAyMDAwMGVkMTQ3ZCJ9.C7_mAg.KT2RcE4BwIFr8GXvTzVrzKXaODQ"
     },
     "data":{
         "id": "00000000-0000-0000-0000-000000000000"
     }
  }

Sample response:

  {
    "id": "00000000-0000-0000-0000-000000000000",
    "title": "NEW CUSTOMERS",
    "type": "base"
  }

Remarks:
In the case of a well-formed request, the response will contain the data of the new category of the customer

The method lets you record the customer's consent to use the platform services and to allow storage and processing of personal data.

The customer consent object has the following fields:

confirmation: type 'string', the method of provision of consent:
- pin - confirmation using the PIN code
- email - confirmation using the link, sent by email
- interface - confirmation by using the UI
- business - confirmation, based on the information, previously collected at points of sale
comment: type 'string', the comment that contains information about when and at which point of sale the information has been collected and consent has been received (for the business confirmation type).
code: type 'string', confirmation code, sent in the message (for pin method of provision of consent)

URL:
- /term/customers/{{id}}/{{id_type}}/consent
- /term/customers/{{id}}/consent - simplified method without specifying the ID type; supports only the following ID types: phone number in international format ('+' at the beginning of the phone number is mandatory), plastic card number, code of the order ('@' at the beginning of the code is mandatory) or QR code from the inCust app.
Method: POST
URL parameters:
- id: customer ID. In the case of the simplified method, it can be only a phone number in international format ('+' at the beginning of the phone number is mandatory), plastic card number, code of the order ('@' at the beginning of the code is mandatory) or QR code from the inCust app
- id_type: the type of the customer ID. Currently, the following types are supported in the system:
  - phone - phone number in international format ('+' at the beginning of the phone number is mandatory)
  - qr - QR code from the inCust app
  - email - customer e-mail (the one used to login to inCust)
  - card - plastic card number
  - temporary-card - customer code, generated by the inCust Terminal app in Steward mode
  - id - customer ID in the inCust system
  - social-network - customer ID in the social network, with FB_ prefix for Facebook and G_ for Google
  - ssn - social security number for the US citizens and residents
  - itin - individual taxpayer's number
Data parameters:
- consent confirmation object

Sample request:

  {
     "method":"POST",
     "url":"https://api.incust.com/v1/term/customers/+12401234567/phone/consent",
     "headers":{
        "Content-Type":"application/json",
        "Accept-Language":"en",
        "Authorization":"bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6IjAyYmE2YmVhLWVjZjMtMTFlNS1hODNhLTAyMDAwMGVkMTQ3ZCJ9.C7_mAg.KT2RcE4BwIFr8GXvTzVrzKXaODQ"
     },
     "data":{
         "code": "",
         "comment": "Test",
         "confirmation": "pin"
     }
  }

If the pin method has been chosen to confirm provision of consent and the code field is not set (is empty or absent), the message with the confirmation code will be sent to the customer automatically, and the response to the request would contain the object with the code set to 0.
```
{
"code":0,
"message":"SMS message with PIN to confirm consent sent to +12401234567"
}
```
After receiving such response, it is required to (a) amend the consent confirmation object with the code field that contains the confirmation code, provided by the customer to the salesperson, and (b) send the consent confirmation object for the repeated processing.

Sample response:

  {
      "app_type": "web",
      "comment": "Test",
      "confirmation": "pin",
      "processed": "2019-08-08T14:55:55.058000Z",
      "request": {
          "method": "POST",
          "remote_addr": "192.168.111.41",
          "url": "https://t.incust.com/v1/term/customers/%2B12401234567/consent"
      },
      "type": "terminal-customer-registration",
      "user": {
          "country": null,
          "email": null,
          "id": "00000000-0000-0000-0000-000000000000",
          "language": null,
          "name": null,
          "phone": "+12401234567"
      }
  }

Remarks:
In the case of a well-formed request and correct data, the response will contain the information about the customer's consent to using the platform services and letting the platform process the customer's personal infromation

Receiving loyalty program rules

This method is required in order to receive a list of the loyalty rules, available for applying manually.

Request for receiving the loyalty program rules

URL: /term/rules
Method: GET
URL parameters:
- no
Data parameters:
- no

Sample request:

  {
     "method":"GET",
     "url":"/term/rules",
     "headers":{
        "Content-Type":"application/json",
        "Accept-Language":"en",
        "Authorization":"bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6IjAyYmE2YmVhLWVjZjMtMTFlNS1hODNhLTAyMDAwMGVkMTQ3ZCJ9.C6Bs-w.UP4cetKh0cVVvMxy85t2ELFNbjk"
     }
  }

Sample response:

  [
     {
        "action_type":"charge-percent-by-item",
        "active":1,
        "applicable_for_sale":"all",
        "automatic":0,
        "charge_type":"regular-bonuses",
        "combine":1,
        "comment":"Discount on goods, %",
        "depends_type":"none",
        "id":"514b5b58-c615-40df-9450-cdf2592e76a9",
        "items_limit_max":0,
        "items_limit_min":0,
        "loyalty_id":"02b6a028-ecf3-11e5-a83a-020000ed147d",
        "priority":5,
        "scheduled":0,
        "title":"Basic Discount",
        "value":[
           {
              "threshold":0,
              "value":0
           }
        ],
        "week_days":[

        ]
     },
     {
        "action_type":"charge-percent-by-item",
        "active":1,
        "applicable_for_sale":"all",
        "automatic":0,
        "charge_type":"regular-bonuses",
        "combine":1,
        "comment":"Credit on goods, %",
        "depends_type":"none",
        "id":"b40db9f5-fe78-4804-bad8-966f16a25a0e",
        "items_limit_max":0,
        "items_limit_min":0,
        "loyalty_id":"02b6a028-ecf3-11e5-a83a-020000ed147d",
        "priority":6,
        "scheduled":0,
        "title":"Crediting",
        "value":[
           {
              "threshold":0,
              "value":0
           }
        ],
        "week_days":[

        ]
     }
  ]

Remarks:
In the case of a well-formed request and correct data, an array containing a list of loyalty program rules available for application will be contained in the response. Of all included fields, later you will need the id field to add the check object to the implemented_rules array and the comment field to show the information about the applicable rules to the salesperson.

Operations with check

The section contains descriptions of all steps of check processing.

Check preparation

Before processing a check it needs to be formed. The example of a check and the required fields are described below.

Example of a formed check:

{
"payment_type":"currency",
"payment_id":"USD",

"amount":35,
"amount_to_pay":35, 
"bonuses_added_amount":0,
"bonuses_added":[

],
"bonuses_redeemed_amount":1,
"special_accounts_charges":[

],
"manual_rules":false,
"implemented_rules":[

"redeemed_coupons": [
   { "code": 246990359478 },
   { "code": 192059545592 }
],
],
"check_items":[
   {
      "title":"Coffee",
      "weighing":0,
      "whole_number":1,
      "variable_price":0,
      "variable_total":0,
      "price_decimal_digits": 2,
      "amount_decimal_digits": 2,
      "bonuses_decimal_digits": 2,
      "special_accounts_decimal_digits": 2,
      "code":"1444",
      "price":10,
      "quantity":1,
      "category":"Drinks",
      "bonuses_redeemed_amount":1,
      "amount":10
   },
   {
      "title":"Ginger tea",
      "weighing":0,
      "whole_number":1,
      "variable_price":0,
      "variable_total":0,
      "price_decimal_digits": 2,
      "amount_decimal_digits": 2,
      "bonuses_decimal_digits": 2,
      "special_accounts_decimal_digits": 2,
      "code":"54321",
      "price":25,
      "quantity":1,
      "category":"Drinks",
      "bonuses_redeemed_amount":0,
      "amount":25
   },
   {
      "title":"Petrol",
      "weighing":0,
      "whole_number":0,
      "variable_price":0,
      "variable_total":0,
      "price_decimal_digits": 2,
      "amount_decimal_digits": 2,
      "bonuses_decimal_digits": 2,
      "special_accounts_decimal_digits": 2,
      "code":"Petrol95",
      "price":25,
      "quantity":10,
      "category":"Fuel",
      "bonuses_redeemed_amount":0,
      "amount":250,
      "additions": {
        "job": {
              "auto_start": true,
              "details": {
                  "fuel": {
                      "nozzle_id": "4f89b9d8-3455-4d05-abcc-2c177c6a180a"
                  }
              },
              "type": "fuel"
        }
      }
   }
],
"id_type":"phone",
"id":"+12401234567",
"amount_decimal_digits": 2,
"bonuses_decimal_digits": 2,
"special_accounts_decimal_digits": 2,
"additions": {
  "odometer": 111111
}
}

payment_type: required parameter, type of payment, the possible values are 'currency', 'special-account'
payment_id: required parameter, payment id,
- if payment_type=='currency', then in this field, it is necessary to provide the currency code of the Terminal
- if payment_type=='special-account', then in this field you need to provide the customer account id.
amount: required parameter, the total cost of all goods in the check
amount_to_pay: The sum to be paid. Upon the first request, it must be equal to amount. In the server's response this field contains the sum with the discounts and redeemed bonus points applied.
discount_amount: discount on a check, calculated automatically on the server
bonuses_redeemed_amount: the amount of redeemed bonus points
- if the bonuses_redeemed_amount is present in the goods of the check, then the sum of the bonus points, redeemed for goods in the check, is distributed according to the values of the corresponding bonuses_redeemed_amount parameter
- if the bonuses_redeemed_amount parameter is not present in the goods of the check, then the sum of the bonus points, redeemed for goods in the check, is distributed according to the cost of the corresponding goods.
bonuses_added_amount: the amount of credited bonus points. It is calculated automatically on the server
special_accounts_charges: an array of objects, which contain customer account credits that are automatically calculated on the server. Object fields:
- amount: amount of crediting
- id: customer account Id, which is being credited
manual_rules: manual rules should be applied (by default is false, automatic rules always apply to the check)
implemented_rules:
- if manual_rules==true, then in this field, it is necessary to transfer an array with one element which contains the Id field with the identifier of the loyalty program rule [{"id":"c785aa00-d288-4384-814e-f33fc074c7b2"}]
- if manual_rules==false, then the response from the server will contain an array of rules which have been applied to the check
redeemed_coupons: In the case when it is necessary to use coupons, an object(s) which contain(s) one field is added to this array 'code' with coupon code, coupon type should be equal to check-modifier, example array: [{ "code": 246990359478 }, { "code": 192059545592 }], In the response to the request to the objects of the coupon, information about the coupon will be added(fields title, description, id) and field applicable indicating whether the coupon is applicable to this check, the values true or false.
check_items: An array of goods added to the check. Each entry must contain the following fields:
- code: code / article of goods
- category: code / article of parent category
- price: price per item
- quantity: number of items
- amount: cost of goods == price * quantity
- bonuses_redeemed_amount: the sum of bonus points redeemed for the given goods item
  - if the value is present, then the sum of the bonus points, redeemed for the goods entry, is distributed according to the given value
  - if the value is not present, then the sum of the bonus points, redeemed for the goods entry, is distributed according to the cost of the corresponding goods.
- discount_amount: discount on goods, calculated automatically on the server
- bonuses_added: the amount of bonus points, credited based on the purchase of the goods. The amount is calculated automatically on the server
- price_decimal_digits: the number of decimal digits in the goods price. If the value is not specified, the system default value is used.
- amount_decimal_digits: the number of decimal digits in the goods total cost. If the value is not specified, the system default value is used.
- bonuses_decimal_digits: the number of decimal digits in the amount of credited and redeemed bonus points. If the value is not specified, the system default value is used.
- special_accounts_decimal_digits: the number of decimal digits in the amount, credited to the customer account. If the value is not specified, the system default value is used.
- additions: Additional (not specific) data of the goods.
  - job: the object that contains the data of the job, which is to be created or added when creating a transaction
    - if it is necessary to add the existing job, then it is sufficient to pass the job's unique ID in this object
    - if the new job is to be created, the object must contain the data of the new job, such as its type and details

id_type: the optional type of the customer ID. Currently, the following types are supported in the system:
- phone - phone number in international format ('+' at the beginning of the phone number is mandatory)
- qr - QR code from the inCust app
- email - customer e-mail (the one used to login to inCust)
- card - plastic card number
- temporary-card - customer code, generated by the inCust Terminal app in Steward mode
- id - customer ID in the inCust system
- social-network - customer ID in the social network, with FB_ prefix for Facebook and G_ for Google
- ssn - social security number for the US citizens and residents
- itin - individual taxpayer's number
id: customer ID. If the identifier type is not specified in id_type parameter, the value of id can be only a phone number in international format ('+' at the beginning of the phone number is mandatory), plastic card number, code of the order ('@' at the beginning of the code is mandatory) or QR code from the inCust app

amount_decimal_digits: the number of decimal digits in the check total sum. If the value is not specified, the system default value is used.
bonuses_decimal_digits: the number of decimal digits in the amount of credited and redeemed bonus points. If the value is not specified, the system default value is used.
special_accounts_decimal_digits: the number of decimal digits in the amount, credited to the customer account. If the value is not specified, the system default value is used.
additions: Additional (not specific) data of the check.

Check processing

To calculate the amount of discounts / credits of bonus points / credits to a customer account, you need to perform a check processing operation. The operation of processing a check is MANDATORY, it must be performed before sending a check for finalization

Request for check processing

URL: /term/process_check
URL: /term/process_check/{rules_type}
Method: POST
URL parameters:
- rules_type - types of rules that must be applied during check calculation:
  - by-all-rules - all types of rules are applied during calculation
  - by-charge-only-rules - only the rules that credit bonus points or customer accounts are applied
  - without-rules - rules are not applied
Data parameters:
- described in Check preparation

Sample request:

  {
     "method":"POST",
     "url":"https://api.incust.com/v1/term/process_check",
     "headers":{
        "Content-Type":"application/json",
        "Accept-Language":"en",
        "Authorization":"bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6ImRmNGYzNzJmLWM0NzktNDNkMi1iNDRhLTg3MDZiZWEyY2EwOSJ9.C5q8aw.KasPpXo01yFhoqei_M02VOLF6Fk"
     },
     "data":{
        "bonuses_added_amount":0,
        "bonuses_added":[

        ],
        "bonuses_redeemed_amount":1,
        "special_accounts_charges":[

        ],
        "manual_rules":false,
        "implemented_rules":[

        ],
        "redeemed_coupons": [
             { "code": 246990359478 },
             { "code": 192059545592 }
        ],
        "check_items":[
           {
              "title":"Coffee",
              "weighing":0,
              "whole_number":1,
              "variable_price":0,
              "variable_total":0,
              "code":"1444",
              "price":4,
              "quantity":1,
              "category":"Drinks",
              "amount":4
           },
           {
              "title":"Ginger tea",
              "weighing":0,
              "whole_number":1,
              "variable_price":0,
              "variable_total":0,
              "code":"54321",
              "price":3,
              "quantity":1,
              "category":"Drinks",
              "amount":3
           }
        ],
        "id_type":"phone",
        "id":"+12401234567",
        "payment_type":"currency",
        "payment_id":"USD",
        "amount":7,
        "amount_to_pay":7
     }
  }

Sample response:

  {
     "amount":7,
     "amount_to_pay":6,
     "bonuses_added":[
        {
           "amount":0.6
        }
     ],
     "bonuses_added_amount":0.6,
     "bonuses_redeemed_amount":1,
     "check_items":[
        {
           "amount":4,
           "bonuses_added":0,
           "category":"Drinks",
           "code":"1444",
           "discount_amount":0,
           "price":4,
           "quantity":1,
           "title":"Coffee",
           "variable_price":0,
           "variable_total":0,
           "weighing":0,
           "whole_number":1
        },
        {
           "amount":3,
           "bonuses_added":0,
           "category":"Drinks",
           "code":"54321",
           "discount_amount":0,
           "price":3,
           "quantity":1,
           "title":"Ginger tea",
           "variable_price":0,
           "variable_total":0,
           "weighing":0,
           "whole_number":1
        }
     ],
     "customer_id":"30ed9ec1-593d-4b68-b090-660c0488a95f",
     "discount_amount":0,
     "error":false,
     "id_type":"phone",
     "id":"+12401234567",
     "implemented_rules":[
        {
           "action_type":"charge-percent-by-check",
           "active":1,
           "applicable_for_sale":"all",
           "automatic":1,
           "charge_type":"regular-bonuses",
           "combine":0,
           "comment":"Bonus loyalty program",
           "depends_type":"none",
           "id":"87f78ba0-b174-11e6-bfd1-020000ed147d",
           "items_limit_max":0,
           "items_limit_min":0,
           "loyalty_id":"87f74cd0-b174-11e6-bfd1-020000ed147d",
           "priority":1,
           "scheduled":0,
           "special_account_id":"23116258-bffd-4b8c-9c42-a3d8c4a941bd",
           "title":"Crediting",
           "value":[
              {
                 "threshold":0,
                 "value":10
              }
           ],
           "week_days":[

           ]
        }
     ],
     "manual_rules":false,
     "payment_id":"USD",
     "payment_type":"currency",
     "redeemed_coupons": [
        {
          "applicable": true,
          "code": 235429115011,
          "description": "Coupon description",
          "id": "2dd82dc2-3a02-11e7-8cbf-020000ed147d",
          "title": "Coupon name"
        },
        {
          "applicable": false,
          "code": 192059545592,
          "description": "Coupon description",
          "id": "2dd82dc2-3a02-11e7-8cbf-020000ed147d",
          "title": "Coupon name"
        }
     ],
     "special_accounts_charges":[

     ]
  }

Remarks:
In the case of a well-formed request and correct data, the response contains the check object, modified according to the credired discounts, bonus points application, etc.

Saving of check with finalization

To complete the operation, it is necessary to finalize (save and close) the check. Before sending a check for finalization it is necessary to process the check object with the check processing method.

Request for check finalization

URL: /term/confirm_check
Method: POST
URL parameters:
- no
Data parameters:
- Pass the check object, received after check processing, as a parameter

Sample request:

  {
     "method":"POST",
     "url":"https://api.incust.com/v1/term/confirm_check",
     "headers":{
        "Content-Type":"application/json",
        "Accept-Language":"en",
        "Authorization":"bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6ImRmNGYzNzJmLWM0NzktNDNkMi1iNDRhLTg3MDZiZWEyY2EwOSJ9.C5q8aw.KasPpXo01yFhoqei_M02VOLF6Fk"
     },
     "data":{
        "amount":35,
        "amount_to_pay":34,
        "bonuses_added":[
           {
              "amount":3.4
           }
        ],
        "bonuses_added_amount":3.4,
        "bonuses_redeemed_amount":1,
        "check_items":[
           {
              "amount":10,
              "bonuses_added":0,
              "category":"Drinks",
              "code":"1444",
              "discount_amount":0,
              "price":10,
              "quantity":1,
              "title":"Coffee",
              "variable_price":0,
              "variable_total":0,
              "weighing":0,
              "whole_number":1
           },
           {
              "amount":25,
              "bonuses_added":0,
              "category":"Drinks",
              "code":"54321",
              "discount_amount":0,
              "price":25,
              "quantity":1,
              "title":"Ginger tea",
              "variable_price":0,
              "variable_total":0,
              "weighing":0,
              "whole_number":1
           }
        ],
        "customer_id":"30ed9ec1-593d-4b68-b090-660c0488a95f",
        "discount_amount":0,
        "error":false,
        "id_type":"phone",
        "id":"+12401234567",
        "implemented_rules":[
           {
              "action_type":"charge-percent-by-check",
              "active":1,
              "applicable_for_sale":"all",
              "automatic":1,
              "charge_type":"regular-bonuses",
              "combine":0,
              "comment":"Bonus loyalty program",
              "depends_type":"none",
              "id":"87f78ba0-b174-11e6-bfd1-020000ed147d",
              "items_limit_max":0,
              "items_limit_min":0,
              "loyalty_id":"87f74cd0-b174-11e6-bfd1-020000ed147d",
              "priority":1,
              "scheduled":0,
              "special_account_id":"23116258-bffd-4b8c-9c42-a3d8c4a941bd",
              "title":"Crediting",
              "value":[
                 {
                    "threshold":0,
                    "value":10
                 }
              ],
              "week_days":[

              ]
           }
        ],
        "manual_rules":false,
        "payment_id":"USD",
        "payment_type":"currency",
        "redeemed_coupons": [
           {
               "applicable": true,
              "code": 235429115011,
              "description": "Coupon description",
              "id": "2dd82dc2-3a02-11e7-8cbf-020000ed147d",
              "title": "Coupon name"
           },
           {
                "applicable": false,
              "code": 192059545592,
              "description": "Coupon description",
              "id": "2dd82dc2-3a02-11e7-8cbf-020000ed147d",
              "title": "Coupon name"
           }
        ],
        "special_accounts_charges":[

        ]
     }
  }

If a phone number or a card number is used as a customer's id in the check, and bonus point redemption or redemption of benefits from the customer account should be performed, then the response to the request will contain an object with 0 code
```
{
"code":0,
"message":"SMS message with transaction confirmation code sent to number +12401234567"
}
```
After receiving such response, you need to perform one of the two actions:
- add the cardotppassword field with the PIN (the one reported by the customer to the salesperson) to the check object, and send the check object for processing once again. If the PIN is not correct, the corresponding error will be returned; otherwise the check will be successfully finalized and closed.
- or, in the case of redemption of bonus points, delete the bonuses_redeemed_amount field and continue the operation without redeeming bonus points.
If the QR code is used as the customer's id in the check, the check will be successfully finalized and closed, confirmation of the operation with the PIN is not required.

Sample response:

  {
      "amount":35,
      "amount_to_pay":34,
      "bonus_account_id":"4cf87c86-ff18-11e6-bfd1-020000ed147d",
      "bonuses_added":3.4,
      "bonuses_on_account":3.4,
      "bonuses_redeemed":1,
      "business_id":"87f710f5-b174-11e6-bfd1-020000ed147d",
      "comment":"",
      "currency":"USD",
      "discount_amount":0,
      "id":"a15ebe59-fff6-11e6-bfd1-020000ed147d",
      "info":"{\"customer_id\":\"30ed9ec1-593d-4b68-b090-660c0488a95f\",\"discount_amount\":0,\"cardotppassword\":\"9166\",\"payment_id\":\"USD\",\"manual_rules\":false,\"bonuses_added\":[{\"expire\":null,\"amount\":3.4}],\"error\":false,\"id\":\"+12401234567\",\"amount\":35,\"special_accounts_charges\":[],\"bonuses_added_amount\":3.4,\"amount_to_pay\":34,\"check_items\":[{\"variable_price\":0,\"discount_amount\":0,\"code\":\"1444\",\"price\":10,\"bonuses_added\":0,\"variable_total\":0,\"category\":\"Drinks\",\"weighing\":0,\"quantity\":1,\"whole_number\":1,\"title\":\"Coffee\",\"amount\":10},{\"variable_price\":0,\"discount_amount\":0,\"code\":\"54321\",\"price\":25,\"bonuses_added\":0,\"variable_total\":0,\"category\":\"Drinks\",\"weighing\":0,\"quantity\":1,\"whole_number\":1,\"title\":\"Ginger tea\",\"amount\":25}],\"bonuses_redeemed_amount\":1,\"implemented_rules\":[{\"automatic\":1,\"scheduled\":0,\"active\":1,\"applicable_for_sale\":\"all\",\"priority\":1,\"loyalty_id\":\"87f74cd0-b174-11e6-bfd1-020000ed147d\",\"title\":\"Crediting\",\"charge_type\":\"regular-bonuses\",\"combine\":0,\"items_limit_min\":0,\"id\":\"87f78ba0-b174-11e6-bfd1-020000ed147d\",\"action_type\":\"charge-percent-by-check\",\"special_account_id\":\"23116258-bffd-4b8c-9c42-a3d8c4a941bd\",\"value\":[{\"threshold\":0,\"value\":10}],\"week_days\":[],\"comment\":\"Bonus loyalty program\",\"items_limit_max\":0,\"depends_type\":\"none\"}],\"payment_type\":\"currency\"}",
      "loyalty_id":"87f74cd0-b174-11e6-bfd1-020000ed147d",
      "online":1,
      "payment_type":"currency",
      "processed":"2017-03-03T09:49:01Z",
      "sms":1,
      "special_account_amount":0,
      "special_account_id":null,
      "terminal_id":"df4f372f-c479-43d2-b44a-8706bea2ca09",
      "transaction_id":null,
      "type":"sale",
      "user_id":"30ed9ec1-593d-4b68-b090-660c0488a95f"
  }

Remarks:
In the case of a well-formed request and correct data, the response contains the object with the information about the performed operation.
- id: check/transaction identifier
- amount: transaction amount
- amount_to_pay: amount to be paid
- bonuses_added: bonus points credited
- bonuses_on_account: bonus points on the customer's account
- bonuses_redeemed: bonus points redeemed
- comment: comment of the transaction

Save check

To reserve the funds and complete payments of the operation, it is necessary to save the check. Before sending the check to saving, it is required to process the check object with check processing method
If the saved check is not finalized within two hours, it is cancelled automatically, and all reserved money are released.

Request for check saving

URL: /term/write_check
Method: POST
URL parameters:
- no
Data parameters:
- Pass the check object, received after check processing, as a parameter

Sample request:

  {
     "method":"POST",
     "url":"https://api.incust.com/v1/term/write_check",
     "headers":{
        "Content-Type":"application/json",
        "Accept-Language":"en",
        "Authorization":"bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6ImRmNGYzNzJmLWM0NzktNDNkMi1iNDRhLTg3MDZiZWEyY2EwOSJ9.C5q8aw.KasPpXo01yFhoqei_M02VOLF6Fk"
     },
     "data":{
        "amount":35,
        "amount_to_pay":34,
        "bonuses_added":[
           {
              "amount":3.4
           }
        ],
        "bonuses_added_amount":3.4,
        "bonuses_redeemed_amount":1,
        "check_items":[
           {
              "amount":10,
              "bonuses_added":0,
              "category":"Drinks",
              "code":"1444",
              "discount_amount":0,
              "price":10,
              "quantity":1,
              "title":"Coffee",
              "variable_price":0,
              "variable_total":0,
              "weighing":0,
              "whole_number":1
           },
           {
              "amount":25,
              "bonuses_added":0,
              "category":"Drinks",
              "code":"54321",
              "discount_amount":0,
              "price":25,
              "quantity":1,
              "title":"Ginger tea",
              "variable_price":0,
              "variable_total":0,
              "weighing":0,
              "whole_number":1
           }
        ],
        "customer_id":"30ed9ec1-593d-4b68-b090-660c0488a95f",
        "discount_amount":0,
        "error":false,
        "id_type":"phone",
        "id":"+12401234567",
        "implemented_rules":[
           {
              "action_type":"charge-percent-by-check",
              "active":1,
              "applicable_for_sale":"all",
              "automatic":1,
              "charge_type":"regular-bonuses",
              "combine":0,
              "comment":"Bonus loyalty program",
              "depends_type":"none",
              "id":"87f78ba0-b174-11e6-bfd1-020000ed147d",
              "items_limit_max":0,
              "items_limit_min":0,
              "loyalty_id":"87f74cd0-b174-11e6-bfd1-020000ed147d",
              "priority":1,
              "scheduled":0,
              "special_account_id":"23116258-bffd-4b8c-9c42-a3d8c4a941bd",
              "title":"Crediting",
              "value":[
                 {
                    "threshold":0,
                    "value":10
                 }
              ],
              "week_days":[

              ]
           }
        ],
        "manual_rules":false,
        "payment_id":"USD",
        "payment_type":"currency",
        "redeemed_coupons": [
            {
              "applicable": true,
              "code": 235429115011,
              "description": "Coupon description",
              "id": "2dd82dc2-3a02-11e7-8cbf-020000ed147d",
              "title": "Coupon name"
            },
            {
              "applicable": false,
              "code": 192059545592,
              "description": "Coupon description",
              "id": "2dd82dc2-3a02-11e7-8cbf-020000ed147d",
              "title": "Coupon name"
            }
        ],
        "special_accounts_charges":[

        ]
     }
  }

If a phone number or a card number is used as the customer's id in the check and bonus point redemption or redemption of benefits from the customer account should be performed, then the response to the request will contain an object with 0 code
```
{
"code":0,
"message":"SMS message with transaction confirmation code sent to number +12401234567"
}
```
After receiving such response, you need to perform one of the two actions:
- add the cardotppassword field with the PIN (the one reported by the customer to the salesperson) to the check object, and send the check object for processing once again. If the PIN is not correct, the corresponding error will be returned; otherwise the check will be saved successfully.
- or, in the case of redemption of bonus points, delete the bonuses_redeemed_amount field and continue the operation without redeeming bonus points.
If the QR code is used as the customer's id in the check, the check will be successfully finalized and closed, confirmation of the operation with the PIN is not required.

Sample response:

  {
      "amount":35,
      "amount_to_pay":34,
      "bonus_account_id":"4cf87c86-ff18-11e6-bfd1-020000ed147d",
      "bonuses_added":3.4,
      "bonuses_on_account":3.4,
      "bonuses_redeemed":1,
      "business_id":"87f710f5-b174-11e6-bfd1-020000ed147d",
      "comment":"",
      "currency":"USD",
      "discount_amount":0,
      "id":"a15ebe59-fff6-11e6-bfd1-020000ed147d",
      "info":"{\"customer_id\":\"30ed9ec1-593d-4b68-b090-660c0488a95f\",\"discount_amount\":0,\"cardotppassword\":\"9166\",\"payment_id\":\"USD\",\"manual_rules\":false,\"bonuses_added\":[{\"expire\":null,\"amount\":3.4}],\"error\":false,\"id\":\"+12401234567\",\"amount\":35,\"special_accounts_charges\":[],\"bonuses_added_amount\":3.4,\"amount_to_pay\":34,\"check_items\":[{\"variable_price\":0,\"discount_amount\":0,\"code\":\"1444\",\"price\":10,\"bonuses_added\":0,\"variable_total\":0,\"category\":\"Drinks\",\"weighing\":0,\"quantity\":1,\"whole_number\":1,\"title\":\"Coffee\",\"amount\":10},{\"variable_price\":0,\"discount_amount\":0,\"code\":\"54321\",\"price\":25,\"bonuses_added\":0,\"variable_total\":0,\"category\":\"Drinks\",\"weighing\":0,\"quantity\":1,\"whole_number\":1,\"title\":\"Ginger tea\",\"amount\":25}],\"bonuses_redeemed_amount\":1,\"implemented_rules\":[{\"automatic\":1,\"scheduled\":0,\"active\":1,\"applicable_for_sale\":\"all\",\"priority\":1,\"loyalty_id\":\"87f74cd0-b174-11e6-bfd1-020000ed147d\",\"title\":\"Crediting\",\"charge_type\":\"regular-bonuses\",\"combine\":0,\"items_limit_min\":0,\"id\":\"87f78ba0-b174-11e6-bfd1-020000ed147d\",\"action_type\":\"charge-percent-by-check\",\"special_account_id\":\"23116258-bffd-4b8c-9c42-a3d8c4a941bd\",\"value\":[{\"threshold\":0,\"value\":10}],\"week_days\":[],\"comment\":\"Bonus loyalty program\",\"items_limit_max\":0,\"depends_type\":\"none\"}],\"payment_type\":\"currency\"}",
      "loyalty_id":"87f74cd0-b174-11e6-bfd1-020000ed147d",
      "online":1,
      "payment_type":"currency",
      "processed":"2017-03-03T09:49:01Z",
      "sms":1,
      "special_account_amount":0,
      "special_account_id":null,
      "terminal_id":"df4f372f-c479-43d2-b44a-8706bea2ca09",
      "transaction_id":null,
      "type":"sale",
      "user_id":"30ed9ec1-593d-4b68-b090-660c0488a95f"
  }

Remarks:
In the case of a well-formed request and correct data, the response contains the object with the information about the performed operation.
- id: check/transaction identifier
- amount: transaction amount
- amount_to_pay: amount to be paid
- bonuses_added: bonus points credited
- bonuses_on_account: bonus points on the customer's account
- bonuses_redeemed: bonus points redeemed
- comment: comment of the transaction

Reserve check

To reserve funds and lock payments for a longer period (up to one month), it is necessary to reserve the check. Before sending the check to saving, it is required to process the check object with check processing method
If the reserved check is not finalized within one month, it is cancelled automatically, and all reserved money are released.

Request for check saving

URL: /term/reserve_check
Method: POST
URL parameters:
- no
Data parameters:
- Pass the check object, received after check processing, as a parameter

Sample request:

  {
     "method":"POST",
     "url":"https://api.incust.com/v1/term/reserve_check",
     "headers":{
        "Content-Type":"application/json",
        "Accept-Language":"en",
        "Authorization":"bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6ImRmNGYzNzJmLWM0NzktNDNkMi1iNDRhLTg3MDZiZWEyY2EwOSJ9.C5q8aw.KasPpXo01yFhoqei_M02VOLF6Fk"
     },
     "data":{
        "amount":35,
        "amount_to_pay":34,
        "bonuses_added":[
           {
              "amount":3.4
           }
        ],
        "bonuses_added_amount":3.4,
        "bonuses_redeemed_amount":1,
        "check_items":[
           {
              "amount":10,
              "bonuses_added":0,
              "category":"Drinks",
              "code":"1444",
              "discount_amount":0,
              "price":10,
              "quantity":1,
              "title":"Coffee",
              "variable_price":0,
              "variable_total":0,
              "weighing":0,
              "whole_number":1
           },
           {
              "amount":25,
              "bonuses_added":0,
              "category":"Drinks",
              "code":"54321",
              "discount_amount":0,
              "price":25,
              "quantity":1,
              "title":"Ginger tea",
              "variable_price":0,
              "variable_total":0,
              "weighing":0,
              "whole_number":1
           }
        ],
        "customer_id":"30ed9ec1-593d-4b68-b090-660c0488a95f",
        "discount_amount":0,
        "error":false,
        "id_type":"phone",
        "id":"+12401234567",
        "implemented_rules":[
           {
              "action_type":"charge-percent-by-check",
              "active":1,
              "applicable_for_sale":"all",
              "automatic":1,
              "charge_type":"regular-bonuses",
              "combine":0,
              "comment":"Bonus loyalty program",
              "depends_type":"none",
              "id":"87f78ba0-b174-11e6-bfd1-020000ed147d",
              "items_limit_max":0,
              "items_limit_min":0,
              "loyalty_id":"87f74cd0-b174-11e6-bfd1-020000ed147d",
              "priority":1,
              "scheduled":0,
              "special_account_id":"23116258-bffd-4b8c-9c42-a3d8c4a941bd",
              "title":"Crediting",
              "value":[
                 {
                    "threshold":0,
                    "value":10
                 }
              ],
              "week_days":[

              ]
           }
        ],
        "manual_rules":false,
        "payment_id":"USD",
        "payment_type":"currency",
        "redeemed_coupons": [
            {
              "applicable": true,
              "code": 235429115011,
              "description": "Coupon description",
              "id": "2dd82dc2-3a02-11e7-8cbf-020000ed147d",
              "title": "Coupon name"
            },
            {
              "applicable": false,
              "code": 192059545592,
              "description": "Coupon description",
              "id": "2dd82dc2-3a02-11e7-8cbf-020000ed147d",
              "title": "Coupon name"
            }
        ],
        "special_accounts_charges":[

        ]
     }
  }

If a phone number or a card number is used as the customer's id in the check, and bonus point redemption or redemption of benefits from the customer account should be performed, then the response to the request will contain an object with 0 code
```
{
"code":0,
"message":"SMS message with transaction confirmation code sent to number +12401234567"
}
```
After receiving such response, you need to perform one of the two actions:
- add the cardotppassword field with the PIN (the one reported by the customer to the salesperson) to the check object, and send the check object for processing once again. If the PIN is not correct, the corresponding error will be returned; otherwise the check will be reserved successfully.
- or, in the case of redemption of bonus points, delete the bonuses_redeemed_amount field and continue the operation without redeeming bonus points.
If the QR code is used as the customer's id in the check, the check will be successfully finalized and closed, confirmation of the operation with the PIN is not required.

Sample response:

  {
      "amount":35,
      "amount_to_pay":34,
      "bonus_account_id":"4cf87c86-ff18-11e6-bfd1-020000ed147d",
      "bonuses_added":3.4,
      "bonuses_on_account":3.4,
      "bonuses_redeemed":1,
      "business_id":"87f710f5-b174-11e6-bfd1-020000ed147d",
      "comment":"",
      "currency":"USD",
      "discount_amount":0,
      "id":"a15ebe59-fff6-11e6-bfd1-020000ed147d",
      "info":"{\"customer_id\":\"30ed9ec1-593d-4b68-b090-660c0488a95f\",\"discount_amount\":0,\"cardotppassword\":\"9166\",\"payment_id\":\"USD\",\"manual_rules\":false,\"bonuses_added\":[{\"expire\":null,\"amount\":3.4}],\"error\":false,\"id\":\"+12401234567\",\"amount\":35,\"special_accounts_charges\":[],\"bonuses_added_amount\":3.4,\"amount_to_pay\":34,\"check_items\":[{\"variable_price\":0,\"discount_amount\":0,\"code\":\"1444\",\"price\":10,\"bonuses_added\":0,\"variable_total\":0,\"category\":\"Drinks\",\"weighing\":0,\"quantity\":1,\"whole_number\":1,\"title\":\"Coffee\",\"amount\":10},{\"variable_price\":0,\"discount_amount\":0,\"code\":\"54321\",\"price\":25,\"bonuses_added\":0,\"variable_total\":0,\"category\":\"Drinks\",\"weighing\":0,\"quantity\":1,\"whole_number\":1,\"title\":\"Ginger tea\",\"amount\":25}],\"bonuses_redeemed_amount\":1,\"implemented_rules\":[{\"automatic\":1,\"scheduled\":0,\"active\":1,\"applicable_for_sale\":\"all\",\"priority\":1,\"loyalty_id\":\"87f74cd0-b174-11e6-bfd1-020000ed147d\",\"title\":\"Crediting\",\"charge_type\":\"regular-bonuses\",\"combine\":0,\"items_limit_min\":0,\"id\":\"87f78ba0-b174-11e6-bfd1-020000ed147d\",\"action_type\":\"charge-percent-by-check\",\"special_account_id\":\"23116258-bffd-4b8c-9c42-a3d8c4a941bd\",\"value\":[{\"threshold\":0,\"value\":10}],\"week_days\":[],\"comment\":\"Bonus loyalty program\",\"items_limit_max\":0,\"depends_type\":\"none\"}],\"payment_type\":\"currency\"}",
      "loyalty_id":"87f74cd0-b174-11e6-bfd1-020000ed147d",
      "online":1,
      "payment_type":"currency",
      "processed":"2017-03-03T09:49:01Z",
      "sms":1,
      "special_account_amount":0,
      "special_account_id":null,
      "terminal_id":"df4f372f-c479-43d2-b44a-8706bea2ca09",
      "transaction_id":null,
      "type":"sale",
      "user_id":"30ed9ec1-593d-4b68-b090-660c0488a95f"
  }

Remarks:
In the case of a well-formed request and correct data, the response contains the object with the information about the performed operation.
- id: check/transaction identifier
- amount: transaction amount
- amount_to_pay: amount to be paid
- bonuses_added: bonus points credited
- bonuses_on_account: bonus points on the customer's account
- bonuses_redeemed: bonus points redeemed
- comment: comment of the transaction

Finalize check

Finalization of the previously saved or reserved check

Request for finalization of the check

URL: /term/finalize_check
Method: POST
URL parameters:
- no
Data parameters:
- id: check identifier, received as the result of the check saving or check reservation operation
- comment: comment

Sample request:

  {
     "method":"POST",
     "url":"https://api.incust.com/v1/term/finalize_check",
     "headers":{
        "Content-Type":"application/json",
        "Accept-Language":"en",
        "Authorization":"bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6ImRmNGYzNzJmLWM0NzktNDNkMi1iNDRhLTg3MDZiZWEyY2EwOSJ9.C5q8aw.KasPpXo01yFhoqei_M02VOLF6Fk"
     },
     "data":{
        "id": "1a640590-293e-11e8-8196-020000ed147d",
        "comment": ""
        }
  }

Sample response:

  {
      "amount":35,
      "amount_to_pay":34,
      "bonus_account_id":"4cf87c86-ff18-11e6-bfd1-020000ed147d",
      "bonuses_added":3.4,
      "bonuses_on_account":3.4,
      "bonuses_redeemed":1,
      "business_id":"87f710f5-b174-11e6-bfd1-020000ed147d",
      "comment":"",
      "currency":"USD",
      "discount_amount":0,
      "id":"a15ebe59-fff6-11e6-bfd1-020000ed147d",
      "info":"{\"customer_id\":\"30ed9ec1-593d-4b68-b090-660c0488a95f\",\"discount_amount\":0,\"cardotppassword\":\"9166\",\"payment_id\":\"USD\",\"manual_rules\":false,\"bonuses_added\":[{\"expire\":null,\"amount\":3.4}],\"error\":false,\"id\":\"+7115050999\",\"amount\":35,\"special_accounts_charges\":[],\"bonuses_added_amount\":3.4,\"amount_to_pay\":34,\"check_items\":[{\"variable_price\":0,\"discount_amount\":0,\"code\":\"1444\",\"price\":10,\"bonuses_added\":0,\"variable_total\":0,\"category\":\"Drinks\",\"weighing\":0,\"quantity\":1,\"whole_number\":1,\"title\":\"Coffee\",\"amount\":10},{\"variable_price\":0,\"discount_amount\":0,\"code\":\"54321\",\"price\":25,\"bonuses_added\":0,\"variable_total\":0,\"category\":\"Drinks\",\"weighing\":0,\"quantity\":1,\"whole_number\":1,\"title\":\"Ginder tea\",\"amount\":25}],\"bonuses_redeemed_amount\":1,\"implemented_rules\":[{\"automatic\":1,\"scheduled\":0,\"active\":1,\"applicable_for_sale\":\"all\",\"priority\":1,\"loyalty_id\":\"87f74cd0-b174-11e6-bfd1-020000ed147d\",\"title\":\"Crediting\",\"charge_type\":\"regular-bonuses\",\"combine\":0,\"items_limit_min\":0,\"id\":\"87f78ba0-b174-11e6-bfd1-020000ed147d\",\"action_type\":\"charge-percent-by-check\",\"special_account_id\":\"23116258-bffd-4b8c-9c42-a3d8c4a941bd\",\"value\":[{\"threshold\":0,\"value\":10}],\"week_days\":[],\"comment\":\"Bonus loyalty program\",\"items_limit_max\":0,\"depends_type\":\"none\"}],\"payment_type\":\"currency\"}",
      "loyalty_id":"87f74cd0-b174-11e6-bfd1-020000ed147d",
      "online":1,
      "payment_type":"currency",
      "processed":"2017-03-03T09:49:01Z",
      "sms":1,
      "special_account_amount":0,
      "special_account_id":null,
      "terminal_id":"df4f372f-c479-43d2-b44a-8706bea2ca09",
      "transaction_id":null,
      "type":"sale",
      "user_id":"30ed9ec1-593d-4b68-b090-660c0488a95f"
  }

Remarks:
In the case of a well-formed request and correct data, the response contains the object with the information about the performed operation.

id: check/transaction identifier
- amount: transaction amount
- amount_to_pay: amount to be paid
- bonuses_added: bonus points credited
- bonuses_on_account: bonus points on the customer's account
- bonuses_redeemed: bonus points redeemed
- comment: comment of the transaction

Create and finalize check

Operation of check creation with finalization. Includes the complete cycle of check processing with creation, writing and finalization.

Request for check creation with finalization

URL: /term/make_check
Method: POST
URL parameters:
- no
Data parameters:
- described in Check preparation

Sample request:

  {
     "method":"POST",
     "url":"https://api.incust.com/v1/term/make_check",
     "headers":{
        "Content-Type":"application/json",
        "Accept-Language":"en",
        "Authorization":"bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6ImRmNGYzNzJmLWM0NzktNDNkMi1iNDRhLTg3MDZiZWEyY2EwOSJ9.C5q8aw.KasPpXo01yFhoqei_M02VOLF6Fk"
     },
     "data":{
        "amount":35,
        "amount_to_pay":34,
        "bonuses_added":[
           {
              "amount":3.4
           }
        ],
        "bonuses_added_amount":3.4,
        "bonuses_redeemed_amount":1,
        "check_items":[
           {
              "amount":10,
              "bonuses_added":0,
              "category":"Drinks",
              "code":"1444",
              "discount_amount":0,
              "price":10,
              "quantity":1,
              "title":"Coffee",
              "variable_price":0,
              "variable_total":0,
              "weighing":0,
              "whole_number":1
           },
           {
              "amount":25,
              "bonuses_added":0,
              "category":"Drinks",
              "code":"54321",
              "discount_amount":0,
              "price":25,
              "quantity":1,
              "title":"Ginger tea",
              "variable_price":0,
              "variable_total":0,
              "weighing":0,
              "whole_number":1
           }
        ],
        "customer_id":"30ed9ec1-593d-4b68-b090-660c0488a95f",
        "discount_amount":0,
        "error":false,
        "id_type":"phone",
        "id":"+12401234567",
        "implemented_rules":[
           {
              "action_type":"charge-percent-by-check",
              "active":1,
              "applicable_for_sale":"all",
              "automatic":1,
              "charge_type":"regular-bonuses",
              "combine":0,
              "comment":"Bonus loyalty program",
              "depends_type":"none",
              "id":"87f78ba0-b174-11e6-bfd1-020000ed147d",
              "items_limit_max":0,
              "items_limit_min":0,
              "loyalty_id":"87f74cd0-b174-11e6-bfd1-020000ed147d",
              "priority":1,
              "scheduled":0,
              "special_account_id":"23116258-bffd-4b8c-9c42-a3d8c4a941bd",
              "title":"Crediting",
              "value":[
                 {
                    "threshold":0,
                    "value":10
                 }
              ],
              "week_days":[

              ]
           }
        ],
        "manual_rules":false,
        "payment_id":"USD",
        "payment_type":"currency",
        "redeemed_coupons": [
           {
               "applicable": true,
              "code": 235429115011,
              "description": "Coupon description",
              "id": "2dd82dc2-3a02-11e7-8cbf-020000ed147d",
              "title": "Coupon name"
           },
           {
                "applicable": false,
              "code": 192059545592,
              "description": "Coupon description",
              "id": "2dd82dc2-3a02-11e7-8cbf-020000ed147d",
              "title": "Coupon name"
           }
        ],
        "special_accounts_charges":[

        ]
     }
  }

If a phone number or a card number is used as a customer's id in the check, and bonus point redemption or redemption of benefits from the customer account should be performed, then the response to the request will contain an object with 0 code
```
{
"code":0,
"message":"SMS message with transaction confirmation code sent to number +12401234567"
}
```
After receiving such response, you need to perform one of the two actions:
- add the cardotppassword field with the PIN (the one reported by the customer to the salesperson) to the check object, and send the check object for processing once again. If the PIN is not correct, the corresponding error will be returned; otherwise the check will be successfully finalized and closed.
- or, in the case of redemption of bonus points, delete the bonuses_redeemed_amount field and continue the operation without redeeming bonus points.
If the QR code is used as the customer's id in the check, the check will be successfully finalized and closed, confirmation of the operation with the PIN is not required.

Sample response:

  {
      "amount":35,
      "amount_to_pay":34,
      "bonus_account_id":"4cf87c86-ff18-11e6-bfd1-020000ed147d",
      "bonuses_added":3.4,
      "bonuses_on_account":3.4,
      "bonuses_redeemed":1,
      "business_id":"87f710f5-b174-11e6-bfd1-020000ed147d",
      "comment":"",
      "currency":"USD",
      "discount_amount":0,
      "id":"a15ebe59-fff6-11e6-bfd1-020000ed147d",
      "info":"{\"customer_id\":\"30ed9ec1-593d-4b68-b090-660c0488a95f\",\"discount_amount\":0,\"cardotppassword\":\"9166\",\"payment_id\":\"USD\",\"manual_rules\":false,\"bonuses_added\":[{\"expire\":null,\"amount\":3.4}],\"error\":false,\"id\":\"+12401234567\",\"amount\":35,\"special_accounts_charges\":[],\"bonuses_added_amount\":3.4,\"amount_to_pay\":34,\"check_items\":[{\"variable_price\":0,\"discount_amount\":0,\"code\":\"1444\",\"price\":10,\"bonuses_added\":0,\"variable_total\":0,\"category\":\"Drinks\",\"weighing\":0,\"quantity\":1,\"whole_number\":1,\"title\":\"Coffee\",\"amount\":10},{\"variable_price\":0,\"discount_amount\":0,\"code\":\"54321\",\"price\":25,\"bonuses_added\":0,\"variable_total\":0,\"category\":\"Drinks\",\"weighing\":0,\"quantity\":1,\"whole_number\":1,\"title\":\"Ginger tea\",\"amount\":25}],\"bonuses_redeemed_amount\":1,\"implemented_rules\":[{\"automatic\":1,\"scheduled\":0,\"active\":1,\"applicable_for_sale\":\"all\",\"priority\":1,\"loyalty_id\":\"87f74cd0-b174-11e6-bfd1-020000ed147d\",\"title\":\"Crediting\",\"charge_type\":\"regular-bonuses\",\"combine\":0,\"items_limit_min\":0,\"id\":\"87f78ba0-b174-11e6-bfd1-020000ed147d\",\"action_type\":\"charge-percent-by-check\",\"special_account_id\":\"23116258-bffd-4b8c-9c42-a3d8c4a941bd\",\"value\":[{\"threshold\":0,\"value\":10}],\"week_days\":[],\"comment\":\"Bonus loyalty program\",\"items_limit_max\":0,\"depends_type\":\"none\"}],\"payment_type\":\"currency\"}",
      "loyalty_id":"87f74cd0-b174-11e6-bfd1-020000ed147d",
      "online":1,
      "payment_type":"currency",
      "processed":"2017-03-03T09:49:01Z",
      "sms":1,
      "special_account_amount":0,
      "special_account_id":null,
      "terminal_id":"df4f372f-c479-43d2-b44a-8706bea2ca09",
      "transaction_id":null,
      "type":"sale",
      "user_id":"30ed9ec1-593d-4b68-b090-660c0488a95f"
  }

Remarks:
In the case of a well-formed request and correct data, the response contains the object with the information about the performed operation.
- id: check/transaction identifier
- amount: transaction amount
- amount_to_pay: amount to be paid
- bonuses_added: bonus points credited
- bonuses_on_account: bonus points on the customer's account
- bonuses_redeemed: bonus points redeemed
- comment: comment of the transaction

Reserve funds for check

The operation lets one reserve funds on a customer account or a bonus points account of a customer, or, if the payment is done via the mobile app, on a bank card of a customer. Before sending a check for finalization it is necessary to process the check object with the check processing method.
The funds are reserved until they are written off by the Write off of the previously reserved funds operation and become unavaialble for further use in other operations.
The funds are reserved for the term up to seven days, after which, if the check has not been finalized and the funds have not been written off, they are released for further use.

Request to reserve funds for check

URL: /term/authorize_payment_check
Method: POST
URL parameters:
- no
Data parameters:
- described in Check preparation

Sample request:

  {
     "method":"POST",
     "url":"https://api.incust.com/v1/term/authorize_payment_check",
     "headers":{
        "Content-Type":"application/json",
        "Accept-Language":"en",
        "Authorization":"bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6ImRmNGYzNzJmLWM0NzktNDNkMi1iNDRhLTg3MDZiZWEyY2EwOSJ9.C5q8aw.KasPpXo01yFhoqei_M02VOLF6Fk"
     },
     "data":{
        "amount":35,
        "amount_to_pay":34,
        "bonuses_added":[
           {
              "amount":3.4
           }
        ],
        "bonuses_added_amount":3.4,
        "bonuses_redeemed_amount":1,
        "check_items":[
           {
              "amount":10,
              "bonuses_added":0,
              "category":"Drinks",
              "code":"1444",
              "discount_amount":0,
              "price":10,
              "quantity":1,
              "title":"Coffee",
              "variable_price":0,
              "variable_total":0,
              "weighing":0,
              "whole_number":1
           },
           {
              "amount":25,
              "bonuses_added":0,
              "category":"Drinks",
              "code":"54321",
              "discount_amount":0,
              "price":25,
              "quantity":1,
              "title":"Ginger tea",
              "variable_price":0,
              "variable_total":0,
              "weighing":0,
              "whole_number":1
           }
        ],
        "customer_id":"30ed9ec1-593d-4b68-b090-660c0488a95f",
        "discount_amount":0,
        "error":false,
        "id_type":"phone",
        "id":"+12401234567",
        "implemented_rules":[
           {
              "action_type":"charge-percent-by-check",
              "active":1,
              "applicable_for_sale":"all",
              "automatic":1,
              "charge_type":"regular-bonuses",
              "combine":0,
              "comment":"Bonus points-based loyalty program",
              "depends_type":"none",
              "id":"87f78ba0-b174-11e6-bfd1-020000ed147d",
              "items_limit_max":0,
              "items_limit_min":0,
              "loyalty_id":"87f74cd0-b174-11e6-bfd1-020000ed147d",
              "priority":1,
              "scheduled":0,
              "special_account_id":"23116258-bffd-4b8c-9c42-a3d8c4a941bd",
              "title":"Crediting",
              "value":[
                 {
                    "threshold":0,
                    "value":10
                 }
              ],
              "week_days":[

              ]
           }
        ],
        "manual_rules":false,
        "payment_id":"USD",
        "payment_type":"currency",
        "special_accounts_charges":[

        ],
        "payments": [
           {"type": "mobile-app", "amount": 34.0}
        ]
     }
  }

If a phone number or a card number is used as a customer's id in the check, and bonus point redemption or redemption of benefits from the customer account should be performed, then the response to the request will contain an object with 0 code
```
{
"code":0,
"message":"SMS message with transaction confirmation code sent to number +12401234567"
}
```
After receiving such response, you need to perform one of the two actions:
- add the cardotppassword field with the PIN (the one reported by the customer to the salesperson) to the check object, and send the check object for processing once again. If the PIN is not correct, the corresponding error will be returned; otherwise the check will be successfully created and the funds will be reserved.
- or, in the case of redemption of bonus points, delete the bonuses_redeemed_amount field and continue the operation without redeeming bonus points.
If the QR code is used as the customer's id in the check, the funds for a check will be successfully authorized, confirmation of the operation with the PIN is not required.

Sample response:

  {
      "amount":35,
      "amount_to_pay":34,
      "bonus_account_id":"4cf87c86-ff18-11e6-bfd1-020000ed147d",
      "bonuses_added":0.0,
      "bonuses_on_account":10.0,
      "bonuses_redeemed":1,
      "business_id":"87f710f5-b174-11e6-bfd1-020000ed147d",
      "comment":"",
      "currency":"USD",
      "discount_amount":0,
      "id":"a15ebe59-fff6-11e6-bfd1-020000ed147d",
      "info":"{\"customer_id\":\"30ed9ec1-593d-4b68-b090-660c0488a95f\",\"discount_amount\":0,\"cardotppassword\":\"9166\",\"payment_id\":\"USD\",\"manual_rules\":false,\"bonuses_added\":[{\"expire\":null,\"amount\":3.4}],\"error\":false,\"id\":\"+12401234567\",\"amount\":35,\"special_accounts_charges\":[],\"bonuses_added_amount\":3.4,\"amount_to_pay\":34,\"check_items\":[{\"variable_price\":0,\"discount_amount\":0,\"code\":\"1444\",\"price\":10,\"bonuses_added\":0,\"variable_total\":0,\"category\":\"Drinks\",\"weighing\":0,\"quantity\":1,\"whole_number\":1,\"title\":\"Coffee\",\"amount\":10},{\"variable_price\":0,\"discount_amount\":0,\"code\":\"54321\",\"price\":25,\"bonuses_added\":0,\"variable_total\":0,\"category\":\"Drinks\",\"weighing\":0,\"quantity\":1,\"whole_number\":1,\"title\":\"Ginger tea\",\"amount\":25}],\"bonuses_redeemed_amount\":1,\"implemented_rules\":[{\"automatic\":1,\"scheduled\":0,\"active\":1,\"applicable_for_sale\":\"all\",\"priority\":1,\"loyalty_id\":\"87f74cd0-b174-11e6-bfd1-020000ed147d\",\"title\":\"Crediting\",\"charge_type\":\"regular-bonuses\",\"combine\":0,\"items_limit_min\":0,\"id\":\"87f78ba0-b174-11e6-bfd1-020000ed147d\",\"action_type\":\"charge-percent-by-check\",\"special_account_id\":\"23116258-bffd-4b8c-9c42-a3d8c4a941bd\",\"value\":[{\"threshold\":0,\"value\":10}],\"week_days\":[],\"comment\":\"Bonus loyalty program\",\"items_limit_max\":0,\"depends_type\":\"none\"}],\"payment_type\":\"currency\"}",
      "loyalty_id":"87f74cd0-b174-11e6-bfd1-020000ed147d",
      "online":1,
      "payment_type":"currency",
      "processed":"2017-03-03T09:49:01Z",
      "sms":1,
      "special_account_amount":0,
      "special_account_id":null,
      "terminal_id":"df4f372f-c479-43d2-b44a-8706bea2ca09",
      "transaction_id":null,
      "type":"authorize-payment",
      "user_id":"30ed9ec1-593d-4b68-b090-660c0488a95f"
  }

Remarks:
In the case of a well-formed request and correct data, the response contains the object with the information about the performed operation.
- id: check/transaction identifier
- amount: transaction amount
- amount_to_pay: amount to be paid
- bonuses_added: bonus points credited
- bonuses_on_account: bonus points on the customer's account
- bonuses_redeemed: bonus points redeemed
- comment: comment of the transaction

Processing of check with previously reserved funds

Calculation of funds (discounts, credited bonus points, and amounts credited on customer accounts) which were previously reserved for the check by the Reserve funds for check operation.

Request for check processing

URL: /term/authorize_payment_check/{{id}}/process_check/{rules_type}
Method: POST
URL parameters:
- id, the unique identifier of the transaction, received as a result of the Reserve funds for check operation
- rules_type - types of rules that must be applied during check calculation:
  - by-all-rules - all types of rules are applied during calculation
  - by-charge-only-rules - only the rules that credit bonus points or customer accounts are applied
  - without-rules - rules are not applied
Data parameters:
- The data of the check (modified or not), used in reservation of funds, and which were received as a result of the Receive check of the transaction operation. They are described in Check preparation.

Sample request:

  {
     "method":"POST",
     "url":"https://api.incust.com/v1/term/authorize_payment_check/a15ebe59-fff6-11e6-bfd1-020000ed147d/process_check/by-all-rules",
     "headers":{
        "Content-Type":"application/json",
        "Accept-Language":"en",
        "Authorization":"bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6ImRmNGYzNzJmLWM0NzktNDNkMi1iNDRhLTg3MDZiZWEyY2EwOSJ9.C5q8aw.KasPpXo01yFhoqei_M02VOLF6Fk"
     },
     "data":{
        "bonuses_added_amount":0,
        "bonuses_added":[

        ],
        "bonuses_redeemed_amount":1,
        "special_accounts_charges":[

        ],
        "manual_rules":false,
        "implemented_rules":[

        ],
        "redeemed_coupons": [
             { "code": 246990359478 },
             { "code": 192059545592 }
        ],
        "check_items":[
           {
              "title":"Coffee",
              "weighing":0,
              "whole_number":1,
              "variable_price":0,
              "variable_total":0,
              "code":"1444",
              "price":4,
              "quantity":1,
              "category":"Drinks",
              "amount":4
           },
           {
              "title":"Ginger tea",
              "weighing":0,
              "whole_number":1,
              "variable_price":0,
              "variable_total":0,
              "code":"54321",
              "price":3,
              "quantity":1,
              "category":"Drinks",
              "amount":3
           }
        ],
        "id_type":"phone",
        "id":"+12401234567",
        "payment_type":"currency",
        "payment_id":"USD",
        "amount":7,
        "amount_to_pay":7
     }
  }

Sample response:

  {
     "amount":7,
     "amount_to_pay":6,
     "bonuses_added":[
        {
           "amount":0.6
        }
     ],
     "bonuses_added_amount":0.6,
     "bonuses_redeemed_amount":1,
     "check_items":[
        {
           "amount":4,
           "bonuses_added":0,
           "category":"Drinks",
           "code":"1444",
           "discount_amount":0,
           "price":4,
           "quantity":1,
           "title":"Coffee",
           "variable_price":0,
           "variable_total":0,
           "weighing":0,
           "whole_number":1
        },
        {
           "amount":3,
           "bonuses_added":0,
           "category":"Drinks",
           "code":"54321",
           "discount_amount":0,
           "price":3,
           "quantity":1,
           "title":"Ginger tea",
           "variable_price":0,
           "variable_total":0,
           "weighing":0,
           "whole_number":1
        }
     ],
     "customer_id":"30ed9ec1-593d-4b68-b090-660c0488a95f",
     "discount_amount":0,
     "error":false,
     "id_type":"phone",
     "id":"+12401234567",
     "implemented_rules":[
        {
           "action_type":"charge-percent-by-check",
           "active":1,
           "applicable_for_sale":"all",
           "automatic":1,
           "charge_type":"regular-bonuses",
           "combine":0,
           "comment":"Bonus loyalty program",
           "depends_type":"none",
           "id":"87f78ba0-b174-11e6-bfd1-020000ed147d",
           "items_limit_max":0,
           "items_limit_min":0,
           "loyalty_id":"87f74cd0-b174-11e6-bfd1-020000ed147d",
           "priority":1,
           "scheduled":0,
           "special_account_id":"23116258-bffd-4b8c-9c42-a3d8c4a941bd",
           "title":"Crediting",
           "value":[
              {
                 "threshold":0,
                 "value":10
              }
           ],
           "week_days":[

           ]
        }
     ],
     "manual_rules":false,
     "payment_id":"USD",
     "payment_type":"currency",
     "redeemed_coupons": [
        {
          "applicable": true,
          "code": 235429115011,
          "description": "Coupon description",
          "id": "2dd82dc2-3a02-11e7-8cbf-020000ed147d",
          "title": "Coupon name"
        },
        {
          "applicable": false,
          "code": 192059545592,
          "description": "Coupon description",
          "id": "2dd82dc2-3a02-11e7-8cbf-020000ed147d",
          "title": "Coupon name"
        }
     ],
     "special_accounts_charges":[

     ]
  }

Remarks:
In the case of a well-formed request and correct data, the response contains the check object, modified according to the credired discounts, bonus points application, etc.

Write off previously reserved funds

The operation of writing off the funds, previously reserved for the check by the Reserve funds for check operation.
The amount of funds that will be written off must not exceed the reserved amount, but can be lower. This way, the data of the check can be altered but only to reduce the cost and the sum of the funds being written off.

Request to write off previously reserved funds

URL: /term/authorize_payment_check/{{id}}/capture
Method: POST
URL parameters:
- id, the unique identifier of the transaction, received as a result of the Reserve funds for check operation
Data parameters:
- The data of the check (modified or not), used in reservation of funds, and which were received as a result of the Receive check of the transaction operation. They are described in Check preparation.

Sample request:

  {
     "method":"POST",
     "url":"https://api.incust.com/v1/term/authorize_payment_check/a15ebe59-fff6-11e6-bfd1-020000ed147d/capture",
     "headers":{
        "Content-Type":"application/json",
        "Accept-Language":"en",
        "Authorization":"bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6ImRmNGYzNzJmLWM0NzktNDNkMi1iNDRhLTg3MDZiZWEyY2EwOSJ9.C5q8aw.KasPpXo01yFhoqei_M02VOLF6Fk"
     },
     "data":{
        "amount":35,
        "amount_to_pay":34,
        "bonuses_added":[
           {
              "amount":3.4
           }
        ],
        "bonuses_added_amount":3.4,
        "bonuses_redeemed_amount":1,
        "check_items":[
           {
              "amount":10,
              "bonuses_added":0,
              "category":"Drinks",
              "code":"1444",
              "discount_amount":0,
              "price":10,
              "quantity":1,
              "title":"Coffee",
              "variable_price":0,
              "variable_total":0,
              "weighing":0,
              "whole_number":1
           },
           {
              "amount":25,
              "bonuses_added":0,
              "category":"Drinks",
              "code":"54321",
              "discount_amount":0,
              "price":25,
              "quantity":1,
              "title":"Ginger tea",
              "variable_price":0,
              "variable_total":0,
              "weighing":0,
              "whole_number":1
           }
        ],
        "customer_id":"30ed9ec1-593d-4b68-b090-660c0488a95f",
        "discount_amount":0,
        "error":false,
        "id_type":"phone",
        "id":"+12401234567",
        "implemented_rules":[
           {
              "action_type":"charge-percent-by-check",
              "active":1,
              "applicable_for_sale":"all",
              "automatic":1,
              "charge_type":"regular-bonuses",
              "combine":0,
              "comment":"Bonus loyalty program",
              "depends_type":"none",
              "id":"87f78ba0-b174-11e6-bfd1-020000ed147d",
              "items_limit_max":0,
              "items_limit_min":0,
              "loyalty_id":"87f74cd0-b174-11e6-bfd1-020000ed147d",
              "priority":1,
              "scheduled":0,
              "special_account_id":"23116258-bffd-4b8c-9c42-a3d8c4a941bd",
              "title":"Crediting",
              "value":[
                 {
                    "threshold":0,
                    "value":10
                 }
              ],
              "week_days":[

              ]
           }
        ],
        "manual_rules":false,
        "payment_id":"USD",
        "payment_type":"currency",
        "special_accounts_charges":[

        ],
        "payments": [
           {"id": "cfdd5efa-1060-4e65-8d28-974bc72de587", "type": "mobile-app", "amount": 34.0}
        ]
     }
  }

If the list of payments is present, each object in it must contain the id attribute - the unique identifier of the payment, received in the data of the check, for which the funds were reserved.

Sample response:

  {
      "amount":35,
      "amount_to_pay":34,
      "bonus_account_id":"4cf87c86-ff18-11e6-bfd1-020000ed147d",
      "bonuses_added":0.0,
      "bonuses_on_account":10.0,
      "bonuses_redeemed":1,
      "business_id":"87f710f5-b174-11e6-bfd1-020000ed147d",
      "comment":"",
      "currency":"USD",
      "discount_amount":0,
      "id":"374c86e1-3ba3-11ea-8e76-020000ed147d",
      "info":"{\"customer_id\":\"30ed9ec1-593d-4b68-b090-660c0488a95f\",\"discount_amount\":0,\"cardotppassword\":\"9166\",\"payment_id\":\"USD\",\"manual_rules\":false,\"bonuses_added\":[{\"expire\":null,\"amount\":3.4}],\"error\":false,\"id\":\"+12401234567\",\"amount\":35,\"special_accounts_charges\":[],\"bonuses_added_amount\":3.4,\"amount_to_pay\":34,\"check_items\":[{\"variable_price\":0,\"discount_amount\":0,\"code\":\"1444\",\"price\":10,\"bonuses_added\":0,\"variable_total\":0,\"category\":\"Drinks\",\"weighing\":0,\"quantity\":1,\"whole_number\":1,\"title\":\"Coffee\",\"amount\":10},{\"variable_price\":0,\"discount_amount\":0,\"code\":\"54321\",\"price\":25,\"bonuses_added\":0,\"variable_total\":0,\"category\":\"Drinks\",\"weighing\":0,\"quantity\":1,\"whole_number\":1,\"title\":\"Ginger tea\",\"amount\":25}],\"bonuses_redeemed_amount\":1,\"implemented_rules\":[{\"automatic\":1,\"scheduled\":0,\"active\":1,\"applicable_for_sale\":\"all\",\"priority\":1,\"loyalty_id\":\"87f74cd0-b174-11e6-bfd1-020000ed147d\",\"title\":\"Crediting\",\"charge_type\":\"regular-bonuses\",\"combine\":0,\"items_limit_min\":0,\"id\":\"87f78ba0-b174-11e6-bfd1-020000ed147d\",\"action_type\":\"charge-percent-by-check\",\"special_account_id\":\"23116258-bffd-4b8c-9c42-a3d8c4a941bd\",\"value\":[{\"threshold\":0,\"value\":10}],\"week_days\":[],\"comment\":\"Bonus loyalty program\",\"items_limit_max\":0,\"depends_type\":\"none\"}],\"payment_type\":\"currency\"}",
      "loyalty_id":"87f74cd0-b174-11e6-bfd1-020000ed147d",
      "online":1,
      "payment_type":"currency",
      "processed":"2017-03-03T09:49:01Z",
      "sms":1,
      "special_account_amount":0,
      "special_account_id":null,
      "terminal_id":"df4f372f-c479-43d2-b44a-8706bea2ca09",
      "transaction_id":"a15ebe59-fff6-11e6-bfd1-020000ed147d",
      "type":"sale",
      "user_id":"30ed9ec1-593d-4b68-b090-660c0488a95f"
  }

Remarks:
In the case of a well-formed request and correct data, the response contains the object with the information about the performed operation.
- id: check/transaction identifier
- amount: transaction amount
- amount_to_pay: amount to be paid
- bonuses_added: bonus points credited
- bonuses_on_account: bonus points on the customer's account
- bonuses_redeemed: bonus points redeemed
- comment: comment of the transaction

Payments

In the inCust platform, it is possible to link payments to the check.

Query payments by check

It is possible to retrieve the list of pyaments, linked to the check.

Querying payments by check

URL:
- /term/payment/check/{{id}}
Method: GET
URL parameters:
- id: Unique identifier of the transaction, the payments for which are requested
Data parameters:
- no

Sample request:

  { 
      "method":"POST",
      "url":"https://api.incust.com/v1/term/payment/check/6839a22e-1c56-11e8-8196-020000ed147d",
      "headers":{ 
          "Content-Type":"application/json",
          "Accept-Language":"en"
          "Authorization":"bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6ImRmNGYzNzJmLWM0NzktNDNkMi1iNDRhLTg3MDZiZWEyY2EwOSJ9.C5q8aw.KasPpXo01yFhoqei_M02VOLF6Fk"
      }
  }

Sample response:

  [
      {
          "amount": 200,
          "change": 300,
          "currency": "USD",
          "id": "7e417bb7-c8b3-46f6-9b78-987d27f3abf6",
          "receipt": 500,
          "status": "success",
          "transaction_id": "6839a22e-1c56-11e8-8196-020000ed147d",
          "type": "cash"
      },
      {
          "amount": 200,
          "currency": "USD",
          "id": "99089853-5ed2-4ffb-8623-b236e28056ff",
          "status": "canceled",
          "transaction_id": "6839a22e-1c56-11e8-8196-020000ed147d",
          "type": "mobile-app"
      },
  ]

Remarks:
In the case of a well-formed request and correct data, the response contains the array of objects with the information about the payment :
- id: unique identifier of the payment
- status: payment status
  - inprocess - payment processing in progress
  - success - payment is successful
  - authorized - payment authorized successfully
  - fail - payment was denied by payment system or bank
  - error - an error has happened during processing of the payment
  - cancelled - payment cancelled
- type: payment type
  - cash - cash
  - mobile-app - payment with mobile app
  - bank-card - payment with credit or debit card
  - special-account - payment from customer account in inCust
- amount: amount of payment
- currency: ISO currency code
- transaction_id: unique identifier of the check / transaction

Add payment to check

It is possible to link the payment to the check.

request for adding payment to check

URL:
- /term/payment/check/{{id}}/add
Method: POST
URL parameters:
- id: unique identifier of the transaction, to which the payments to retrieve are linked
Data parameters:
- The array of objects with the information about the payment that must be added:
  - type: payment type
    - cash - cash
    - mobile-app - payment with mobile app
    - bank-card - payment with credit or debit card
    - special-account - payment from customer account in inCust
  - amount: amount

Sample request:

  { 
      "method":"POST",
      "url":"https://api.incust.com/v1/term/payment/check/6839a22e-1c56-11e8-8196-020000ed147d/add",
      "headers":{ 
          "Content-Type":"application/json",
          "Accept-Language":"en"
          "Authorization":"bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6ImRmNGYzNzJmLWM0NzktNDNkMi1iNDRhLTg3MDZiZWEyY2EwOSJ9.C5q8aw.KasPpXo01yFhoqei_M02VOLF6Fk"
      },
      "data": [
          {
              "type": "cash", 
              "amount": 200
          }
      ]
  }

Sample response:

  [
      {
          "amount": 200,
          "change": 300,
          "currency": "USD",
          "id": "7e417bb7-c8b3-46f6-9b78-987d27f3abf6",
          "receipt": 500,
          "status": "success",
          "transaction_id": "6839a22e-1c56-11e8-8196-020000ed147d",
          "type": "cash"
      },
      {
          "amount": 200,
          "currency": "USD",
          "id": "99089853-5ed2-4ffb-8623-b236e28056ff",
          "status": "canceled",
          "transaction_id": "6839a22e-1c56-11e8-8196-020000ed147d",
          "type": "mobile-app"
      },
  ]

Remarks:
In the case of a well-formed request and correct data, the response contains the array of objects with the payment information

Cancel payment by check

It is possible to cancel the payment, previously linked to the check.

Request to cancel the payment by check

URL:
- /term/payment/check/{{id}}/cancel
Method: POST
URL parameters:
- id: unique identifier of the transaction, to which the payments to retrieve are linked
Data parameters:
- An array of identifiers of the payments that must be cancelled

Sample request:

  { 
      "method":"POST",
      "url":"https://api.incust.com/v1/term/payment/check/6839a22e-1c56-11e8-8196-020000ed147d/add",
      "headers":{ 
          "Content-Type":"application/json",
          "Accept-Language":"en"
          "Authorization":"bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6ImRmNGYzNzJmLWM0NzktNDNkMi1iNDRhLTg3MDZiZWEyY2EwOSJ9.C5q8aw.KasPpXo01yFhoqei_M02VOLF6Fk"
      },
      "data": [
          "99089853-5ed2-4ffb-8623-b236e28056ff",
          "c2ecbcff-d39c-417b-9723-fd09a7c5278c"
      ]
  }

Sample response:

  [
      {
          "amount": 200,
          "change": 300,
          "currency": "USD",
          "id": "7e417bb7-c8b3-46f6-9b78-987d27f3abf6",
          "receipt": 500,
          "status": "success",
          "transaction_id": "6839a22e-1c56-11e8-8196-020000ed147d",
          "type": "cash"
      },
      {
          "amount": 200,
          "currency": "USD",
          "id": "99089853-5ed2-4ffb-8623-b236e28056ff",
          "status": "canceled",
          "transaction_id": "6839a22e-1c56-11e8-8196-020000ed147d",
          "type": "mobile-app"
      },
  ]

Remarks:
In the case of a well-formed request and correct data, the response contains the array of objects with the payment information

Sending of information about payment to app for customers

Terminal can send the information about the payment to the app for customers

Request for sending of information about the payment to the app for customers

URL:
- /term/payment/mobileapp/message
Method: POST
URL parameters:
- no
Data parameters:
- id: unique ID of the transaction, related to the payment that has been made

Sample request:

  { 
      "method":"POST",
      "url":"https://api.incust.com/v1/term/payment/mobileapp/message",
      "headers":{ 
          "Content-Type":"application/json",
          "Accept-Language":"en"
          "Authorization":"bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6ImRmNGYzNzJmLWM0NzktNDNkMi1iNDRhLTg3MDZiZWEyY2EwOSJ9.C5q8aw.KasPpXo01yFhoqei_M02VOLF6Fk"
      },
      "data": {
          "id": "1017db3a-fba0-11e7-8196-020000ed147d"
      }
  }

Sample response:

  {
      "id": "44886507-6776-4f67-b799-82f3efcf1693",
      "status": "success",
      "type": "ipay"
  }

Remarks:
In the case of a well-formed request and correct data, the response contains the object that contains the data of the payment:
- id: Unique payment ID
- status: payment status
  - inprocess - the payment is being processed
  - success - the payment is successful
  - authorized - payment authorized successfully
  - fail - the payment is denied by the payment system or bank
  - error - the error has happened when processing the payment
  - cancelled - the payment has been cancelled
- type: the type of the payment system

Retrieval of payment status

Terminal can request the status of the mobile payment by transaction or check.

Retrieval of payment status

URL:
- /term/payment/mobileapp/status
Method: POST
URL parameters:
- no
Data parameters:
- id: unique ID of the transaction, related to the payment that has been made

Sample request:

  { 
      "method":"POST",
      "url":"https://api.incust.com/v1/term/payment/mobileapp/status",
      "headers":{ 
          "Content-Type":"application/json",
          "Accept-Language":"en"
          "Authorization":"bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6ImRmNGYzNzJmLWM0NzktNDNkMi1iNDRhLTg3MDZiZWEyY2EwOSJ9.C5q8aw.KasPpXo01yFhoqei_M02VOLF6Fk"
      },
      "data": {
          "id": "1017db3a-fba0-11e7-8196-020000ed147d"
      }
  }

Sample response:

  {
      "id": "44886507-6776-4f67-b799-82f3efcf1693",
      "status": "success",
      "type": "ipay"
  }

Remarks:
In the case of a well-formed request and correct data, the response contains the object that contains the data of the payment:
- id: Unique payment ID
- status: payment status
  - inprocess - the payment is being processed
  - success - the payment is successful
  - authorized - payment authorized successfully
  - fail - the payment is denied by the payment system or bank
  - error - the error has happened when processing the payment
  - cancelled - the payment has been cancelled
- type: the type of the payment system

Transactions

The section contains descriptions of all operations with transactions

Transaction object

The object contains the general information about the transaction

Sample information about the transaction:

{
  "amount": 1000.0,
  "amount_to_pay": 900.0,
  "bonus_account_id": "004f0d0e-0de9-11e6-bfd1-000000ed147d",
  "bonuses_added": 0.0,
  "bonuses_on_account": 36168.75,
  "bonuses_redeemed": 100.0,
  "business_id": "12343b7e-0d35-11e6-bfd1-020000e1237d",
  "cancelled": 0,
  "comment": "",
  "currency": "USD",
  "discount_amount": 0.0,
  "errors": [
      {
          "code": 170,
          "level": "warning",
          "message": "Transaction failed. You cannot charge more funds than authorized.",
          "type": "authorized-payment-capture"
      }
  ],
  "finalized": "2020-05-05T15:36:28.777000Z",
  "finalized_local": "2020-05-05T18:36:28.777000Z",
  "id": "ba723454-8ee5-11ea-b744-021230ed147d",
  "loyalty_id": "b4e262e7-0d35-11e6-bfd1-020000ed147d",
  "payment_type": "currency",
  "processed": "2020-05-05T15:33:11.470000Z",
  "processed_local": "2020-05-05T18:33:11.470000Z",
  "shipping_amount": 0.0,
  "special_account_amount": 0.0,
  "terminal_id": "b4e123ee-0d35-11e6-bfd1-0234506d147d",
  "type": "authorize-payment",
  "user_id": "9873eb97-fe7f-46fc-9fb2-5093474de415"
}

id: unique transaction identifier
type: payment type
- reserve - reservation of the check for up to one month (commonly used in the e-shop)
- presale - reservation of the check for up to one (commonly used to make a payment)
- authorize-payment - reservation of funds for the check for up to 7 days
- sale - sale on check
- cancel - cancellation of the transaction
- bonus-add - crediting of bonus points
- special-account-refill - top up of the customer account
- coupon-sale - sale of the coupon to the customer
transaction_id: unique identifier of the related transaction
processed: Transaction date and time in the YYYY-MM-DD[T]HH:mm:ss[Z] format, UTC timezone
processed_local: Transaction date and time in the YYYY-MM-DD[T]HH:mm:ss[Z] format, Terminal timezone
finalized: Date and time of finalization of the transaction in the YYYY-MM-DD[T]HH:mm:ss[Z] format, UTC timezone
finalized_local: Date and time of finalization of the transaction in the YYYY-MM-DD[T]HH:mm:ss[Z], Terminal timezone
cancelled: The field signals that the transaction has been cancelled
payment_type: type of payment, the possible values are 'currency', 'special-account' for payment with money and charging the customer account respectively
currency: currency of the transaction,
- if payment_type=='currency', then this is the currency of charging the funds and crediting of bonus points
- if payment_type=='special-account', then this is the currency of crediting of bonus points
amount: sum of the check
amount_to_pay: sum to pay after discounts and redeemed bonus points
shipping_amount: cost of shipping
discount_amount: discount on check
bonuses_redeemed: the sum of redeemed bonus points
bonuses_added: the sum of credited bonus points
bonus_account_id: the unique identifier of the bonus account, from/to which the bonus points are redeemed/credited
special_account_id: the unique identifier of the customer account from which the funds are charged
comment: comment for the operation
user_id: the unique identifier of the customer's user record
errors: an array of objects that contain errors and warnings which happened during processing of the transaction:
- type: the type of the operation that caused an error:
  - transaction-post-processing - actions, performed during processing of the transaction after its creation
  - authorized-payment-capture - actions, performed when writing off previously reserved funds
- level: error severity:
  - error - error
  - warning - warning
- message: error text
- code: error code

Receiving a list of transactions

Request for receiving a list of transactions

URL: /term/transactions
Method: GET
URL parameters:
- date_from, type 'string', date and time in format YYYY-MM-DD[T]HH:mm:ss[Z]
- date_to, type 'string', date and time in format YYYY-MM-DD[T]HH:mm:ss[Z]
- user_id, type 'string', unique identifier of user (optional)
- page, type 'integer', page number in the pagination, page counting starts from 1
- count, type 'integer', the number of items in the batch of pagination,
- sort, type 'string', transaction sorting, in the "sorting_field sorting_direction" format
  - sorting_field, type 'string', the possible values are amount, amount_to_pay, bonuses_added, bonuses_on_account, bonuses_redeemed, cancelled, comment, payment_type, processed, sms, type, user_name, user_phone
  - sorting_direction, type 'string', the possible values are ASC, DESC
Data parameters:
- no

Sample request:

  {
     "method":"GET",
     "url":"https://api.incust.com/v1/term/transactions?date_from=2016-03-09T22:00:00Z&date_to=2017-03-10T21:59:59Z&page=1&count=10&sort=processed DESC",
     "headers":{
        "Content-Type":"application/json",
        "Accept-Language":"en",
        "Authorization":"bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6ImRmNGYzNzJmLWM0NzktNDNkMi1iNDRhLTg3MDZiZWEyY2EwOSJ9.C6RYXQ.ngqoZ9V9Jpx0_EDuPBHv4lCgpCw"
     }
  }

Sample response:

  {
     "data":[
        {
           "amount":255,
           "amount_to_pay":248,
           "bonus_account_id":"520d370f-05a3-11e7-aa6b-020000ed147d",
           "bonuses_added":24.8,
           "bonuses_on_account":24.8,
           "bonuses_redeemed":7,
           "business_id":"87f710f5-b174-11e6-bfd1-020000ed147d",
           "cancelled":0,
           "comment":"",
           "currency":"USD",
           "discount_amount":0,
           "id":"982c96da-05a3-11e7-aa6b-020000ed147d",
           "loyalty_id":"87f74cd0-b174-11e6-bfd1-020000ed147d",
           "loyalty_title":"Super Pizza - Stock, Auth",
           "online":1,
           "payment_type":"currency",
           "pos_title":"Super Pizza",
           "processed":"2017-03-10T15:09:44Z",
           "processed_local":"2017-03-10T17:09:44Z",
           "sc_bonuses_redeem":null,
           "sc_code":null,
           "sc_created":null,
           "sc_terminal_id":null,
           "sc_terminal_login":null,
           "sc_terminal_phone":null,
           "sc_terminal_title":null,
           "sms":1,
           "special_account_amount":0,
           "special_account_id":null,
           "terminal_id":"df4f372f-c479-43d2-b44a-8706bea2ca09",
           "terminal_login":"endemo",
           "terminal_phone":null,
           "terminal_title":"Terminal, Authentification Kiosk",
           "transaction_id":null,
           "type":"sale",
           "user_id":"7b136b01-8dd8-40de-a06c-6c4e1b58c5bc",
           "user_name":"Andrew",
           "user_phone":"+1994148003"
        },
        {
           "amount":10,
           "amount_to_pay":10,
           "bonus_account_id":"4cf87c86-ff18-11e6-bfd1-020000ed147d",
           "bonuses_added":1,
           "bonuses_on_account":1,
           "bonuses_redeemed":0,
           "business_id":"87f710f5-b174-11e6-bfd1-020000ed147d",
           "cancelled":0,
           "comment":"",
           "currency":"USD",
           "discount_amount":0,
           "id":"4cf8995b-ff18-11e6-bfd1-020000ed147d",
           "loyalty_id":"87f74cd0-b174-11e6-bfd1-020000ed147d",
           "loyalty_title":"Super Pizza - Stock, Auth",
           "online":1,
           "payment_type":"currency",
           "pos_title":"Super Pizza",
           "processed":"2017-03-02T07:17:31Z",
           "processed_local":"2017-03-02T09:17:31Z",
           "sc_bonuses_redeem":null,
           "sc_code":null,
           "sc_created":null,
           "sc_terminal_id":null,
           "sc_terminal_login":null,
           "sc_terminal_phone":null,
           "sc_terminal_title":null,
           "sms":1,
           "special_account_amount":0,
           "special_account_id":null,
           "terminal_id":"df4f372f-c479-43d2-b44a-8706bea2ca09",
           "terminal_login":"endemo",
           "terminal_phone":null,
           "terminal_title":"Terminal, Authentication Kiosk",
           "transaction_id":null,
           "type":"sale",
           "user_id":"30ed9ec1-593d-4b68-b090-660c0488a95f",
           "user_name":"123",
           "user_phone":"+12401234567"
        }
     ],
     "summary":{
        "total_amount":14115,
        "total_amount_to_pay":13586,
        "total_bonuses_added":1363,
        "total_bonuses_redeemed":490,
        "total_discount_amount":0,
        "total_rows_count":177
     }
  }

Remarks:
In the case of a well-formed request and correct data, the response contains the object with two fields:
- data: an array of transaction objects
- summary: general information about the sample
  - total_amount: total purchase amount
  - total_amount_to_pay: total value of the amount to pay
  - total_bonuses_added: total amount of credited bonus points
  - total_bonuses_redeemed: total amount of redeemed bonus points
  - total_discount_amount: total amount of applied discounts
  - total_rows_count: total amount of transactions in the sample

Cancellation of transaction

Request for cancellation of transaction

URL: /term/transaction_cancel
Method: POST
URL parameters:
- no
Data parameters:
- transaction_id, type 'string', transaction id, it is present in the transaction object that is returned in the transaction array by the /term/transactions method
- comment, type 'string', the comment of transaction cancellation operation

Sample request:

  {
     "method":"POST",
     "url":"https://api.incust.com/v1/term/transaction_cancel",
     "headers":{
        "Content-Type":"application/json",
        "Accept-Language":"en",
        "Authorization":"bearer eyJ0ZXJtaW5hbF9pZCI6IjAyYmE2YmVhLWVjZjMtMTFlNS1hODNhLTAyMDAwMGVkMTQ3ZCIsInZlcnNpb24iOjF9.C6RfdA.1hcHsBbsYA9Ez38YEhdEJKBvNN8"
     },
     "data":{
        "transaction_id":"04fb8bdd-fffd-11e6-bfd1-020000ed147d",
        "comment":"Reason of cancellation"
     }
  }

Sample response:

  {
     "amount":2,
     "amount_to_pay":2,
     "bonus_account_id":"a26bed76-348c-11e6-bfd1-020000ed147d",
     "bonuses_added":0,
     "bonuses_on_account":3936.26,
     "bonuses_redeemed":0,
     "business_id":"02b61320-ecf3-11e5-a83a-020000ed147d",
     "comment":"",
     "currency":"USD",
     "discount_amount":0,
     "id":"219ee372-05ae-11e7-aa6b-020000ed147d",
     "info":"{\"transaction_id\":\"5510f163-fffb-11e6-bfd1-020000ed147d\"}",
     "loyalty_id":"02b6a028-ecf3-11e5-a83a-020000ed147d",
     "online":1,
     "payment_type":"special-account",
     "processed":"2017-03-10T16:25:10Z",
     "sms":0,
     "special_account_amount":221,
     "special_account_id":"54358709-2f1a-41c5-8c82-3d8792d5a56d",
     "terminal_id":"02ba6bea-ecf3-11e5-a83a-020000ed147d",
     "transaction_id":"5510f163-fffb-11e6-bfd1-020000ed147d",
     "type":"cancel",
     "user_id":"d2b57641-8583-4c5e-a8db-04dafe2e140d"
  }

Receive information about the transaction

request to receive information about the transaction

URL: /term/transaction/{id}
Method: GET
URL parameters:
- id, unique ID of the transaction, information about which must be retrieved
Data parameters:
- no

Sample request:

  {
     "method":"GET",
     "url":"https://api.incust.com/v1/term/transaction/982c96da-05a3-11e7-aa6b-020000ed147d",
     "headers":{
        "Content-Type":"application/json",
        "Accept-Language":"en",
        "Authorization":"bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6ImRmNGYzNzJmLWM0NzktNDNkMi1iNDRhLTg3MDZiZWEyY2EwOSJ9.C6RYXQ.ngqoZ9V9Jpx0_EDuPBHv4lCgpCw"
     }
  }

Sample response:

  {
           "amount":255,
           "amount_to_pay":248,
           "bonus_account_id":"520d370f-05a3-11e7-aa6b-020000ed147d",
           "bonuses_added":24.8,
           "bonuses_on_account":24.8,
           "bonuses_redeemed":7,
           "business_id":"87f710f5-b174-11e6-bfd1-020000ed147d",
           "cancelled":0,
           "comment":"",
           "currency":"USD",
           "discount_amount":0,
           "id":"982c96da-05a3-11e7-aa6b-020000ed147d",
           "loyalty_id":"87f74cd0-b174-11e6-bfd1-020000ed147d",
           "loyalty_title":"Super Pizza - Stock, Auth",
           "online":1,
           "payment_type":"currency",
           "pos_title":"Super Pizza",
           "processed":"2017-03-10T15:09:44Z",
           "processed_local":"2017-03-10T17:09:44Z",
           "sc_bonuses_redeem":null,
           "sc_code":null,
           "sc_created":null,
           "sc_terminal_id":null,
           "sc_terminal_login":null,
           "sc_terminal_phone":null,
           "sc_terminal_title":null,
           "sms":1,
           "special_account_amount":0,
           "special_account_id":null,
           "terminal_id":"df4f372f-c479-43d2-b44a-8706bea2ca09",
           "terminal_login":"endemo",
           "terminal_phone":null,
           "terminal_title":"Terminal, Authentication Kiosk",
           "transaction_id":null,
           "type":"sale",
           "user_id":"7b136b01-8dd8-40de-a06c-6c4e1b58c5bc",
           "user_name":"Andrew",
           "user_phone":"+1994148003"
  }

Remarks:
In the case of a well-formed request and correct data, the response contains the object of the transaction

Receive check of the transaction

Receiving of the object with the check, based on which the transaction was created.

Request to retrieve information about check of the transaction

URL: /term/transaction/{id}/check
Method: GET
URL parameters:
- id, unique ID of the transaction, information about whose check must be retrieved
Data parameters:
- no

Sample request:

  {
     "method":"GET",
     "url":"https://api.incust.com/v1/term/transaction/982c96da-05a3-11e7-aa6b-020000ed147d/check",
     "headers":{
        "Content-Type":"application/json",
        "Accept-Language":"en",
        "Authorization":"bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6ImRmNGYzNzJmLWM0NzktNDNkMi1iNDRhLTg3MDZiZWEyY2EwOSJ9.C6RYXQ.ngqoZ9V9Jpx0_EDuPBHv4lCgpCw"
     }
  }

Sample response:

  {
     "amount":7,
     "amount_to_pay":6,
     "bonuses_added":[
        {
           "amount":0.6
        }
     ],
     "bonuses_added_amount":0.6,
     "bonuses_redeemed_amount":1,
     "check_items":[
        {
           "amount":4,
           "bonuses_added":0,
           "category":"Drinks",
           "code":"1444",
           "discount_amount":0,
           "price":4,
           "quantity":1,
           "title":"Coffee",
           "variable_price":0,
           "variable_total":0,
           "weighing":0,
           "whole_number":1
        },
        {
           "amount":3,
           "bonuses_added":0,
           "category":"Drinks",
           "code":"54321",
           "discount_amount":0,
           "price":3,
           "quantity":1,
           "title":"Ginger tea",
           "variable_price":0,
           "variable_total":0,
           "weighing":0,
           "whole_number":1
        }
     ],
     "customer_id":"30ed9ec1-593d-4b68-b090-660c0488a95f",
     "discount_amount":0,
     "error":false,
     "id_type":"phone",
     "id":"+12401234567",
     "implemented_rules":[
        {
           "action_type":"charge-percent-by-check",
           "active":1,
           "applicable_for_sale":"all",
           "automatic":1,
           "charge_type":"regular-bonuses",
           "combine":0,
           "comment":"Bonus loyalty program",
           "depends_type":"none",
           "id":"87f78ba0-b174-11e6-bfd1-020000ed147d",
           "items_limit_max":0,
           "items_limit_min":0,
           "loyalty_id":"87f74cd0-b174-11e6-bfd1-020000ed147d",
           "priority":1,
           "scheduled":0,
           "special_account_id":"23116258-bffd-4b8c-9c42-a3d8c4a941bd",
           "title":"Crediting",
           "value":[
              {
                 "threshold":0,
                 "value":10
              }
           ],
           "week_days":[

           ]
        }
     ],
     "manual_rules":false,
     "payment_id":"USD",
     "payment_type":"currency",
     "redeemed_coupons": [
        {
          "applicable": true,
          "code": 235429115011,
          "description": "Coupon description",
          "id": "2dd82dc2-3a02-11e7-8cbf-020000ed147d",
          "title": "Coupon name"
        },
        {
          "applicable": false,
          "code": 192059545592,
          "description": "Coupon description",
          "id": "2dd82dc2-3a02-11e7-8cbf-020000ed147d",
          "title": "Coupon name"
        }
     ],
     "special_accounts_charges":[

     ]
  }

Remarks:
In the case of a well-formed request and correct data, the response contains the object of the check, used to create the transaction

Code of the order

Code of the order is the temporary code, generated by the Terminal app that lets one identify the customer and, when enabled during generation, redeem benefits, such as bonus points and items from customer accounts.

Generation of code of order

Terminal offers generation of the code of the order. In the case, when the code allows redemption of benefits, it will be sent to the customer. Otherwise, the code will be returned as the response to the request.

Request for generation of code of order

URL:
- /term/generate_temporary_code/{{id}}/{{id_type}}
- /term/generate_temporary_code/{{id}} - simplified method without specifying the ID type; supports only the following ID types: phone number in international format ('+' at the beginning of the phone number is mandatory), plastic card number or QR code from the inCust app.
Method: GET
URL parameters:
- id: customer ID. In the case of the simplified method, it can be only a phone number in international format ('+' at the beginning of the phone number is mandatory), plastic card number or QR code from the inCust app
- id_type: the type of the customer ID. Currently, the following types are supported in the system:
  - phone - phone number in international format ('+' at the beginning of the phone number is mandatory)
  - qr - QR code from the inCust app
  - email - customer e-mail (the one used to login to inCust)
  - card - plastic card number
  - id - customer ID in the inCust system
  - social-network - customer ID in the social network, with FB_ prefix for Facebook and G_ for Google
  - ssn - social security number for the US citizens and residents
  - itin - individual taxpayer's number
- redeem_allowed: defines whether it's allowed to redeem benefits. Type is boolean (true – yes, false – no).
Data parameters:
- no

Sample request:

  {
     "method":"GET",
     "url":"https://api.incust.com/v1/term/generate_temporary_code/+1112233444/phone?redeem_allowed=false",
     "headers":{
        "Content-Type":"application/json",
        "Accept-Language":"en",
        "Authorization":"bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6ImRmNGYzNzJmLWM0NzktNDNkMi1iNDRhLTg3MDZiZWEyY2EwOSJ9.C5q8aw.KasPpXo01yFhoqei_M02VOLF6Fk"
     }
  }

The sample response for the code that doesn't let one redeem benefits:

  {
     "message":"",
     "code":"123456",
     "redeem_allowed":false
  }

The sample response for the code that lets one redeem benefits:

  {
     "message":"The SMS with the order code was sent to the guest's phone. This code allows you not just to credit, but also to redeem the bonus points. Ask the guest to tell you the code.",
     "code":"",
     "redeem_allowed":true
  }

Remarks:
If the QR code was passed as the customer ID, the response will always be of the first time, i.e. it will contain the code of the order.

The response will contain the following fields:
- message: system message
- code: code of the order
- redeem_allowed: defines whether it's allowed to redeem benefits. Type is boolean (true – yes, false – no).

Retrieval of the code of the latest order, generated by Terminal app in Steward mode

Terminal lets you obtain the latest code, generated by Terminal app in Register or Steward modes that works under the same account as the given Terminal.

Request for the latest code, generated by Terminal app in Steward mode

URL:
- /term/last_temporary_code?time_delta={{time_delta}}
Method: GET
URL parameters:
- time_delta: Time period, for which the search is done, minutes. Default value is 5 minutes.
Data parameters:
- no

Sample request:

  {
     "method":"GET",
     "url":"https://api.incust.com/v1/term/last_temporary_code?time_delta=30",
     "headers":{
        "Content-Type":"application/json",
        "Accept-Language":"en",
        "Authorization":"bearer eyJ0ZXJtaW5hbF9pZCI6IjAyYmE2YmVhLWVjZjMtMTFlNS1hODNhLTAyMDAwMGVkMTQ3ZCIsInZlcnNpb24iOjF9.C5rXRQ.FVbaHN0go0FK3EbWIXtEg9AvNbg"
     }
  }

Sample response:

  {
      "code": "176820",
      "redeem_allowed": true
  }

Remarks:
In the case of a well-formed request and correct data, the response will contain an object with the code:
- code: code of the order
- redeem_allowed: defines whether it's allowed to redeem benefits. Type is boolean (true – yes, false – no).
  
  In the case of absense of the code in the specified time period, an object with the error message will be returned.
```
{
  "code": 114,
  "message": "Card code does not exist"
}
```

Customer identifiers

Each customer has one or several identifiers, such as such as phone number, email, social network ID, plasctic card number etc.

Searching for customers by identifiers

When having the identifier or several identifiers, such as phone number, email, social network ID etc., Terminal can search for customers in the inCust system, whose records match the identifiers.
If several specified identifiers belong to different accounts, all accounts that include at least one of the specified identifiers will be returned.

Request for searching for customers by identifiers

URL:
- /term/customers
Method: POST
URL parameters:
- no
Data parameters:
- identification: an array of identifier objects that contain the following fields:
  - code, type: string, value of the identifier
  - type, type: string, type of the identifier:
    - phone - phone number in international format ('+' at the beginning of the phone number is mandatory)
    - qr - QR code from the inCust app
    - email - customer e-mail (the one used to login to inCust)
    - card - plastic card number
    - temporary-card - customer code, generated by the inCust Terminal app in Steward mode
    - id - customer ID in the inCust system
    - social-network - customer ID in the social network, with FB_ prefix for Facebook and G_ for Google
    - ssn - social security number for the US citizens and residents
    - itin - individual taxpayer's number
  - scope, type: string, only for plastic cards, identifier scope:
    - loyalty - the card is active only within the loyalty program
    - business - the card is active within the business

Sample request:

  { 
      "method":"POST",
      "url":"https://api.incust.com/v1/term/customers",
      "headers":{ 
          "Content-Type":"application/json",
          "Accept-Language":"en"
          "Authorization":"bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6ImRmNGYzNzJmLWM0NzktNDNkMi1iNDRhLTg3MDZiZWEyY2EwOSJ9.C5q8aw.KasPpXo01yFhoqei_M02VOLF6Fk"
      },
      "data": {
          "identification": [
              {
                  "code": "+1112233444",
                  "type": "phone"
              },
              {
                  "code": "+1112233555",
                  "type": "phone"
              },
              {
                  "code": "test.user@gmail.com",
                  "type": "email"
              },
              {
                  "code": "G_111222333444",
                  "type": "social-network"
              },
              {
                  "code": "TEST001",
                  "type": "card",
                  "scope": "loyalty"
              }
          ]
      }
  }

Sample response:

  [
      {
          "birth_date": "2016-06-23",
          "country": "US",
          "gender": "male",
          "id": "6c6b9de5-0426-4798-b307-056cad79ca2a",
          "identification": [
              {
                  "code": "+1112233444",
                  "type": "phone"
              },
              {
                  "code": "qqq@qqq.com",
                  "type": "email"
              },
              {
                  "code": "TEST111",
                  "scope": "loyalty",
                  "type": "card"
              }
          ],
          "language": "en",
          "name": "Test 1"
      },
      {
          "birth_date": "1913-09-20",
          "country": "US",
          "gender": "male",
          "id": "0573eb97-fe7f-46fc-9fb2-5495074de415",
          "identification": [
              {
                  "code": "+1112233555",
                  "type": "phone"
              },
              {
                  "code": "TEST001",
                  "scope": "loyalty",
                  "type": "card"
              },
              {
                  "code": "TEST010",
                  "scope": "loyalty",
                  "type": "card"
              }
          ],
          "language": "en",
          "name": "Test 2"
      },
      {
          "birth_date": "2015-12-31",
          "country": "US",
          "id": "233bcf69-38c6-4268-9ac9-dcb03382430f",
          "identification": [
              {
                  "code": "+1111111111",
                  "type": "phone"
              },
              {
                  "code": "G_111222333444",
                  "type": "social-network"
              }
          ],
          "language": "en",
          "name": "SN test"
      }
  ]

Remarks:
In the case of a well-formed request and correct data, the response will contain an array of objects with the data of found customer accounts:
- id: unique customer ID in the inCust system
- name: customer's name
- language: customer's language (ISO language code)
- country: country language (ISO country code)
- birth_date: customer's birth date
- gender: customer's gender
- identification: array of objects with customer identifiers:
  - id, type: string, unique identifier of the identifier
  - code, type: string, identifier value
  - type, type: string, identifier type:
    - phone - phone number in international format ('+' at the beginning of the phone number is mandatory)
    - qr - QR code from the inCust app
    - email - customer e-mail (the one used to login to inCust)
    - card - plastic card number
    - temporary-card - customer code, generated by the inCust Terminal app in Steward mode
    - id - customer ID in the inCust system
    - social-network - customer ID in the social network, with FB_ prefix for Facebook and G_ for Google
    - ssn - social security number for the US citizens and residents
    - itin - individual taxpayer's number
  - scope, type: string, only for plastic cards, identifier scope:
    - loyalty - the card is active only within the loyalty program
    - business - the card is active within the business

Registration of customer with specified identifiers

Terminal can add a customer record to inCust system, using the set of identifiers of the customer, such as phone number, email address, social network ID etc.

Request for addition of customer with specified identifiers

URL:
- /term/customers/add
Method: POST
URL parameters:
- no
Data parameters:
- name: customer's name
- language: customer's language (ISO language code)
- country: country language (ISO country code)
- birth_date: customer's birth date
- gender: customer's gender
- identification: array of objects with customer identifiers:
  - code, type: string, identifier value
  - type, type: string, identifier type:
    - phone - phone number in international format ('+' at the beginning of the phone number is mandatory)
    - qr - QR code from the inCust app
    - email - customer e-mail (the one used to login to inCust)
    - card - plastic card number
    - temporary-card - customer code, generated by the inCust Terminal app in Steward mode
    - id - customer ID in the inCust system
    - social-network - customer ID in the social network, with FB_ prefix for Facebook and G_ for Google
    - ssn - social security number for the US citizens and residents
    - itin - individual taxpayer's number
  - scope, type: string, only for plastic cards, identifier scope:
    - loyalty - the card is active only within the loyalty program
    - business - the card is active within the business

Sample request:

  { 
      "method":"POST",
      "url":"https://api.incust.com/v1/term/customers/add",
      "headers":{ 
          "Content-Type":"application/json",
          "Accept-Language":"en"
          "Authorization":"bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6ImRmNGYzNzJmLWM0NzktNDNkMi1iNDRhLTg3MDZiZWEyY2EwOSJ9.C5q8aw.KasPpXo01yFhoqei_M02VOLF6Fk"
      },
      "data": {
          "country": "US",
          "language": "en",
          "name": "test",
          "identification": [
              {
                  "code": "FB_111222333444",
                  "type": "social-network"
              },
              {
                  "code": "+1112221111",
                  "type": "phone"
              }
          ]
      }
  }

Sample response:

  {
      "country": "US",
      "id": "d7007606-4e90-48d4-baf5-37548cca459f",
      "identification": [
          {
              "code": "+1112221111",
              "type": "phone"
          },
          {
              "code": "FB_111222333444",
              "type": "social-network"
          }
      ],
      "language": "en",
      "name": "test"
  }

Remarks:
In the case of a well-formed request and correct data, the response will contain an object with the data of the created customer account:
- id: unique customer ID in the inCust system
- name: customer's name
- language: customer's language (ISO language code)
- country: country language (ISO country code)
- birth_date: customer's birth date
- gender: customer's gender
- identification: array of objects with customer identifiers:
  - id, type: string, unique identifier of the identifier
  - code, type: string, identifier value
  - type, type: string, identifier type:
    - phone - phone number in international format ('+' at the beginning of the phone number is mandatory)
    - qr - QR code from the inCust app
    - email - customer e-mail (the one used to login to inCust)
    - card - plastic card number
    - temporary-card - customer code, generated by the inCust Terminal app in Steward mode
    - id - customer ID in the inCust system
    - social-network - customer ID in the social network, with FB_ prefix for Facebook and G_ for Google
    - ssn - social security number for the US citizens and residents
    - itin - individual taxpayer's number
  - scope, type: string, only for plastic cards, identifier scope:
    - loyalty - the card is active only within the loyalty program
    - business - the card is active within the business
  If there exist customers with such identifiers in the system, the object with the error will be returned:
```
{
  "code": 28,
  "message": "Customer with the same identifiers already exists"
}
```

Retrieval of customer identifiers

Terminal can retrieve all customer's identifiers in the inCust system.

Request for retrieval of customer identifiers

URL:
- /term/customers/{{id}}/{{id_type}}/identification
- /term/customers/{{id}}/identification - simplified method without specifying the ID type; supports only the following ID types: phone number in international format ('+' at the beginning of the phone number is mandatory), plastic card number or QR code from the inCust app.
Method: GET
URL parameters:
- id: customer ID. In the case of the simplified method, it can be only a phone number in international format ('+' at the beginning of the phone number is mandatory), plastic card number, code of the order ('@' at the beginning of the code is mandatory) or QR code from the inCust app
- id_type: the type of the customer ID. Currently, the following types are supported in the system:
  - phone - phone number in international format ('+' at the beginning of the phone number is mandatory)
  - qr - QR code from the inCust app
  - email - customer e-mail (the one used to login to inCust)
  - card - plastic card number
  - temporary-card - customer code, generated by the inCust Terminal app in Steward mode
  - id - customer ID in the inCust system
  - social-network - customer ID in the social network, with FB_ prefix for Facebook and G_ for Google
  - ssn - social security number for the US citizens and residents
  - itin - individual taxpayer's number
Data parameters:
- no
Sample request:
```
  {
     "method":"GET",
     "url":"https://api.incust.com/v1/term/customers/+12401234567/phone/identification",
     "headers":{
        "Content-Type":"application/json",
        "Accept-Language":"en",
        "Authorization":"bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6ImRmNGYzNzJmLWM0NzktNDNkMi1iNDRhLTg3MDZiZWEyY2EwOSJ9.C5q8aw.KasPpXo01yFhoqei_M02VOLF6Fk"
     }
  }
```
Sample of the url for simplified request:
1. for phone number https://api.incust.com/v1/term/customers/+12401234567/identification
2. for card number https://api.incust.com/v1/term/customers/123456/identification
3. for order code https://api.incust.com/v1/term/customers/@123456/identification
4. for QR code https://api.incust.com/v1/term/customers/1,+12401234567,1488530852,59EFCB1A2FE68D1865365BB8C38532527B61A19259F394/identification

Sample response:

  {
      "country": "US",
      "id": "d7007606-4e90-48d4-baf5-37548cca459f",
      "identification": [
          {
              "id": "53806ff7-87e9-45dd-afa2-ddbdc7b38d63",
              "code": "+1112221111",
              "type": "phone"
          },
          {
              "id": "53806ff7-87e9-45dd-afa2-ddbdc7b38d65",
              "code": "FB_111222333444",
              "type": "social-network"
          }
      ],
      "language": "en",
      "name": "test"
  }

Remarks:
In the case of a well-formed request and correct data, the response contains the object that contains the data about the registered customer:
- id: unique customer ID in the inCust system
- name: customer's name
- language: customer's language (ISO language code)
- country: country language (ISO country code)
- birth_date: customer's birth date
- gender: customer's gender
- identification: array of objects with customer identifiers:
  - id, type: string, unique identifier of the identifier
  - code, type: string, identifier value
  - type, type: string, identifier type:
    - phone - phone number in international format ('+' at the beginning of the phone number is mandatory)
    - qr - QR code from the inCust app
    - email - customer e-mail (the one used to login to inCust)
    - card - plastic card number
    - temporary-card - customer code, generated by the inCust Terminal app in Steward mode
    - id - customer ID in the inCust system
    - social-network - customer ID in the social network, with FB_ prefix for Facebook and G_ for Google
    - ssn - social security number for the US citizens and residents
    - itin - individual taxpayer's number
  - scope, type: string, only for plastic cards, identifier scope:
    - loyalty - the card is active only within the loyalty program
    - business - the card is active within the business

Addition of customer identifiers

Terminal can add identifiers to the customer's record in the inCust system.

Request for addition of customer identifiers

URL:
- /term/customers/{{id}}/{{id_type}}/identification
- /term/customers/{{id}}/identification - simplified method without specifying the ID type; supports only the following ID types: phone number in international format ('+' at the beginning of the phone number is mandatory), plastic card number or QR code from the inCust app.
Method: POST
URL parameters:
- id: customer ID. In the case of the simplified method, it can be only a phone number in international format ('+' at the beginning of the phone number is mandatory), plastic card number, code of the order ('@' at the beginning of the code is mandatory) or QR code from the inCust app
- id_type: the type of the customer ID. Currently, the following types are supported in the system:
  - phone - phone number in international format ('+' at the beginning of the phone number is mandatory)
  - qr - QR code from the inCust app
  - email - customer e-mail (the one used to login to inCust)
  - card - plastic card number
  - temporary-card - customer code, generated by the inCust Terminal app in Steward mode
  - id - customer ID in the inCust system
  - social-network - customer ID in the social network, with FB_ prefix for Facebook and G_ for Google
  - ssn - social security number for the US citizens and residents
  - itin - individual taxpayer's number
Data parameters:
- an array of identifier objects that contain the following fields:
  - code, type: string, identifier value
  - type, type: string, identifier type:
    - phone - phone number in international format ('+' at the beginning of the phone number is mandatory)
    - qr - QR code from the inCust app
    - email - customer e-mail (the one used to login to inCust)
    - card - plastic card number
    - temporary-card - customer code, generated by the inCust Terminal app in Steward mode
    - id - customer ID in the inCust system
    - social-network - customer ID in the social network, with FB_ prefix for Facebook and G_ for Google
    - ssn - social security number for the US citizens and residents
    - itin - individual taxpayer's number
  - scope, type: string, only for plastic cards, identifier scope:
    - loyalty - the card is active only within the loyalty program
    - business - the card is active within the business

Sample request:

  { 
      "method":"POST",
      "url":"https://api.incust.com/v1/term/customers/+12401234567/phone/identification",
      "headers":{ 
          "Content-Type":"application/json",
          "Accept-Language":"en"
          "Authorization":"bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6ImRmNGYzNzJmLWM0NzktNDNkMi1iNDRhLTg3MDZiZWEyY2EwOSJ9.C5q8aw.KasPpXo01yFhoqei_M02VOLF6Fk"
      },
      "data": [
              {
                  "code": "FB_111222333444",
                  "type": "social-network"
              },
              {
                  "code": "+1112221111",
                  "type": "phone"
              }
      ]
  }

Sample response:

  [
      {
          "added": true,
          "id": "07bb6571-bfaa-44cd-90c6-f9c3142d9b91",
          "code": "+1112221111",
          "type": "phone"
      },
      {
          "added": false,
          "error": "Customer with such identifiers already exists",
          "code": "FB_111222333444",
          "type": "social-network"
      }
  ]

Remarks:
In the case of a well-formed request and correct data, the response contains the object that contains the array of identifier objects:
- an array of objects with customer identifiers:
  - id, type: string, unique identifier of the identifier
  - code, type: string, identifier value
  - type, type: string, identifier type:
    - phone - phone number in international format ('+' at the beginning of the phone number is mandatory)
    - qr - QR code from the inCust app
    - email - customer e-mail (the one used to login to inCust)
    - card - plastic card number
    - temporary-card - customer code, generated by the inCust Terminal app in Steward mode
    - id - customer ID in the inCust system
    - social-network - customer ID in the social network, with FB_ prefix for Facebook and G_ for Google
    - ssn - social security number for the US citizens and residents
    - itin - individual taxpayer's number
  - scope, type: string, only for plastic cards, identifier scope:
    - loyalty - the card is active only within the loyalty program
    - business - the card is active within the business
  - added, type: boolean, status of addition of the ID
  - error, type: string, error description

Removal of customer identifiers

Terminal can remove some identifiers, such as plastic card numbers and alike, from the customer record in the inCust system

Request for removal of customer identifiers

URL:
- /term/customers/{{id}}/{{id_type}}/identification/delete
- /term/customers/{{id}}/identification/delete - simplified method without specifying the ID type; supports only the following ID types: phone number in international format ('+' at the beginning of the phone number is mandatory), plastic card number or QR code from the inCust app.
Method: POST
URL parameters:
- id: customer ID. In the case of the simplified method, it can be only a phone number in international format ('+' at the beginning of the phone number is mandatory), plastic card number, code of the order ('@' at the beginning of the code is mandatory) or QR code from the inCust app
- id_type: the type of the customer ID. Currently, the following types are supported in the system:
  - phone - phone number in international format ('+' at the beginning of the phone number is mandatory)
  - qr - QR code from the inCust app
  - email - customer e-mail (the one used to login to inCust)
  - card - plastic card number
  - temporary-card - customer code, generated by the inCust Terminal app in Steward mode
  - id - customer ID in the inCust system
  - social-network - customer ID in the social network, with FB_ prefix for Facebook and G_ for Google
  - ssn - social security number for the US citizens and residents
  - itin - individual taxpayer's number
Data parameters:
- an array of identifier objects that contain the following fields:
  - id, type: string, unique identifier of the identifier
  - code, type: string, identifier value
  - type, type: string, identifier type:
    - phone - phone number in international format ('+' at the beginning of the phone number is mandatory)
    - qr - QR code from the inCust app
    - email - customer e-mail (the one used to login to inCust)
    - card - plastic card number
    - temporary-card - customer code, generated by the inCust Terminal app in Steward mode
    - id - customer ID in the inCust system
    - social-network - customer ID in the social network, with FB_ prefix for Facebook and G_ for Google
    - ssn - social security number for the US citizens and residents
    - itin - individual taxpayer's number
  - scope, type: string, only for plastic cards, identifier scope:
    - loyalty - the card is active only within the loyalty program
    - business - the card is active within the business

Sample request:

  { 
      "method":"POST",
      "url":"https://api.incust.com/v1/term/customers/+12401234567/phone/identification/delete",
      "headers":{ 
          "Content-Type":"application/json",
          "Accept-Language":"en"
          "Authorization":"bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6ImRmNGYzNzJmLWM0NzktNDNkMi1iNDRhLTg3MDZiZWEyY2EwOSJ9.C5q8aw.KasPpXo01yFhoqei_M02VOLF6Fk"
      },
      "data": [
              {
                  "id": "07bb6571-bfaa-44cd-90c6-f9c3142d9b90",
                  "code": "FB_111222333444",
                  "type": "social-network"
              },
              {
                  "id": "07bb6571-bfaa-44cd-90c6-f9c3142d9b91",
                  "code": "+1112221111",
                  "type": "phone"
              }
      ]
  }

Sample response:

  [
      {
          "deleted": false,
          "error": "Operation not permitted",
          "code": "+1112221111",
          "type": "phone"
      },
      {
          "deleted": true,
          "code": "FB_111222333444",
          "type": "social-network"
      }
  ]

Remarks:
In the case of a well-formed request and correct data, the response contains the object that contains the array of identifier objects:
- an array of objects with customer identifiers:
  - id, type: string, unique identifier of the identifier
  - code, type: string, identifier value
  - type, type: string, identifier type:
    - phone - phone number in international format ('+' at the beginning of the phone number is mandatory)
    - qr - QR code from the inCust app
    - email - customer e-mail (the one used to login to inCust)
    - card - plastic card number
    - temporary-card - customer code, generated by the inCust Terminal app in Steward mode
    - id - customer ID in the inCust system
    - social-network - customer ID in the social network, with FB_ prefix for Facebook and G_ for Google
    - ssn - social security number for the US citizens and residents
    - itin - individual taxpayer's number
  - scope, type: string, only for plastic cards, identifier scope:
    - loyalty - the card is active only within the loyalty program
    - business - the card is active within the business
  - deleted, type: boolean, status of removal of the ID
  - error, type: string, error description

Coupons

Operations with coupons

Issue coupons of the series

Issuing of coupons by the specified series. The issued coupons are not added to the customer's wallet.

Requet to issue coupons of the series

URL:
- /term/coupons/batch/{{code}}/emission
Method: GET
URL parameters:
- code: coupon series code
- count: the number of coupons to issue
Data parameters:
- no

Sample request:

  {
     "method":"GET",
     "url":"https://api.incust.com/v1/term/coupons/batch/1111-1111-1111/emission?count=5,
     "headers":{
        "Content-Type":"application/json",
        "Authorization":"bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6IjAyYmE2YmVhLWVjZjMtMTFlNS1hODNhLTAyMDAwMGVkMTQ3ZCJ9.C7UthA.wvYZuI-vrJymIlEI15EHdT7kcIY"
     }
  }

Sample response:

  [
     {
        "batch":{
           "business_id":"02b61320-ecf3-11e5-a83a-020000ed147d",
           "exchange_coupon_redeem_fee":0,
           "id":"3dc71a1f-1483-11e7-898a-020000ed147d",
           "image":"https://api.incust.com/static/13/87/5540302b42ea96fcfe833c43312a.jpeg",
           "loyalty_id":"02b6a028-ecf3-11e5-a83a-020000ed147d",
           "public_description":"Coupon description",
           "public_title":"Coupon name",
           "share_allowed":0,
           "type":"check-modifier"
        },
        "code":"246990359478",
        "id":"4081a81a-1483-11e7-898a-020000ed147d",
        "status":"open"
     },
     {
        "batch":{
           "business_id":"02b61320-ecf3-11e5-a83a-020000ed147d",
           "exchange_coupon_redeem_fee":0,
           "id":"17ec7187-3bd2-11e7-8cbf-020000ed147d",
           "loyalty_id":"02b6a028-ecf3-11e5-a83a-020000ed147d",
           "public_description":"Coupon description",
           "public_title":"Coupon name",
           "recommendation_fee_amount":1,
           "recommendation_fee_bonuses_currency":"USD",
           "recommendation_fee_promotional_bonuses_expire_date":"2017-06-19",
           "recommendation_fee_promotional_bonuses_expire_type":"date",
           "recommendation_fee_promotional_bonuses_expire_value":0,
           "recommendation_fee_type":"promotional-bonuses",
           "share_allowed":1,
           "type":"certificate"
        },
        "code":"192059545592",
        "id":"46884efe-4d1b-11e7-8cbf-020000ed147d",
        "status":"open"
     }
  ]

Remarks:
In the case of a well-formed request and correct data, the response includes an array of coupon objects

Retrieve coupon data

Retrieval of the data data about coupon by code or external code.

Request to retrieve data about coupon

URL:
- /term/coupons/coupon/get
Method: POST
URL parameters:
- no
Data parameters:
- code: coupon code
- external_code: external coupon code

Sample request:

  {
     "method":"POST",
     "url":"/term/coupons/coupon/get",
     "headers":{
        "Content-Type":"application/json",
        "Accept-Language":"en",
        "Authorization":"bearer eyJ0ZXJtaW5hbF9pZCI6IjAyYmE2YmVhLWVjZjMtMTFlNS1hODNhLTAyMDAwMGVkMTQ3ZCIsInZlcnNpb24iOjF9.C6RfdA.1hcHsBbsYA9Ez38YEhdEJKBvNN8"
     },
     "data": { "code": 246990359478 }
  }

Sample response:

  [
     {
        "batch":{
           "business_id":"02b61320-ecf3-11e5-a83a-020000ed147d",
           "exchange_coupon_redeem_fee":0,
           "id":"3dc71a1f-1483-11e7-898a-020000ed147d",
           "image":"https://api.incust.com/static/13/87/5540302b42ea96fcfe833c43312a.jpeg",
           "loyalty_id":"02b6a028-ecf3-11e5-a83a-020000ed147d",
           "public_description":"Coupon description",
           "public_title":"Coupon name",
           "share_allowed":0,
           "type":"check-modifier"
        },
        "code":"246990359478",
        "id":"4081a81a-1483-11e7-898a-020000ed147d",
        "status":"open"
     }
  ]

Remarks:
In the case of a well-formed request and correct data, the response includes an array of coupon objects

Use coupon without customer

External coupons can be used without a customer.

Use coupon without customer

URL:
- /term/coupons/redeem
Method: POST
URL parameters:
- no

Data parameters:

array of objects with id fields, that contain coupon id, e.g. [{ "id": "4081a81a-1483-11e7-898a-020000ed147d" }, { "id": "46884efe-4d1b-11e7-8cbf-020000ed147d" }]

{
 "method":"POST",
 "url":"https://api.incust.com/v1/term/coupons/redeem",
 "headers":{
    "Content-Type":"application/json",
    "Accept-Language":"en",
    "Authorization":"bearer eyJ0ZXJtaW5hbF9pZCI6IjAyYmE2YmVhLWVjZjMtMTFlNS1hODNhLTAyMDAwMGVkMTQ3ZCIsInZlcnNpb24iOjF9.C6RfdA.1hcHsBbsYA9Ez38YEhdEJKBvNN8"
 },
 "data":[
    { "id": "4081a81a-1483-11e7-898a-020000ed147d" },
    { "id": "46884efe-4d1b-11e7-8cbf-020000ed147d" }
 ]
}

Sample response:

  [
     {
        "batch":{
           "business_id":"02b61320-ecf3-11e5-a83a-020000ed147d",
           "exchange_coupon_redeem_fee":6,
           "id":"79e43946-3bd4-11e7-8cbf-020000ed147d",
           "image":"https://api.incust.com/static/d3/3b/a235a2fb4af7960dcb3691c3cc54.jpeg",
           "loyalty_id":"02b6a028-ecf3-11e5-a83a-020000ed147d",
           "public_description":"Coupon description",
           "public_title":"Coupon name",
           "recommendation_fee_type":"none",
           "share_allowed":1,
           "type":"certificate"
        },
        "code":"131720042556",
        "id":"7a165695-3bd4-11e7-8cbf-020000ed147d",
        "redeemed":true,
        "status":"redeemed"
     },
     {
        "batch":{
           "business_id":"02b61320-ecf3-11e5-a83a-020000ed147d",
           "exchange_coupon_redeem_fee":6,
           "id":"79e43946-3bd4-11e7-8cbf-020000ed147d",
           "image":"https://api.incust.com/static/d3/3b/a235a2fb4af7960dcb3691c3cc54.jpeg",
           "loyalty_id":"02b6a028-ecf3-11e5-a83a-020000ed147d",
           "public_description":"Coupon description",
           "public_title":"Coupon name",
           "recommendation_fee_type":"none",
           "share_allowed":1,
           "type":"certificate"
        },
        "code":"131720042556",
        "id":"7a165695-3bd4-11e7-8cbf-020000ed147d",
        "redeemed":true,
        "status":"redeemed"
     }
  ]

Remarks:
In the case of a well-formed request and correct data, the response includes an array of objects of coupon type. The "coupon" object will additionally contain the redeemed field, that keeps the result of the coupon redeeming (possible values are true or false)

List of coupons, added to customer's wallet

The list includes all coupons, added to the customer's wallet, which were not redeemed and didn't expire.

Request to receive the list of coupons, added to the customer's wallet

URL:
- /term/coupons/{{id}}/{{id_type}}
- /term/coupons/{{id}} - simplified method without specifying the ID type; supports only the following ID types: phone number in international format ('+' at the beginning of the phone number is mandatory), plastic card number, code of the order ('@' at the beginning of the code is mandatory) or QR code from the inCust app.
Method: GET
URL parameters:
- id: customer ID. In the case of the simplified method, it can be only a phone number in international format ('+' at the beginning of the phone number is mandatory), plastic card number, code of the order ('@' at the beginning of the code is mandatory) or QR code from the inCust app
- id_type: the type of the customer ID. Currently, the following types are supported in the system:
  - phone - phone number in international format ('+' at the beginning of the phone number is mandatory)
  - qr - QR code from the inCust app
  - email - customer e-mail (the one used to login to inCust)
  - card - plastic card number
  - temporary-card - customer code, generated by the inCust Terminal app in Steward mode
  - id - customer ID in the inCust system
  - social-network - customer ID in the social network, with FB_ prefix for Facebook and G_ for Google
  - ssn - social security number for the US citizens and residents
  - itin - individual taxpayer's number
Data parameters:
- no

Sample request:

  {
     "method":"GET",
     "url":"https://api.incust.com/v1/term/coupons/+1432112233444/phone",
     "headers":{
        "Content-Type":"application/json",
        "Authorization":"bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6IjAyYmE2YmVhLWVjZjMtMTFlNS1hODNhLTAyMDAwMGVkMTQ3ZCJ9.C7UthA.wvYZuI-vrJymIlEI15EHdT7kcIY"
     }
  }

Sample response:

  [
     {
        "batch":{
           "business_id":"02b61320-ecf3-11e5-a83a-020000ed147d",
           "exchange_coupon_redeem_fee":0,
           "id":"3dc71a1f-1483-11e7-898a-020000ed147d",
           "image":"https://api.incust.com/static/13/87/5540302b42ea96fcfe833c43312a.jpeg",
           "loyalty_id":"02b6a028-ecf3-11e5-a83a-020000ed147d",
           "public_description":"Coupon description",
           "public_title":"Coupon name",
           "share_allowed":0,
           "type":"check-modifier"
        },
        "code":"246990359478",
        "id":"4081a81a-1483-11e7-898a-020000ed147d",
        "status":"open"
     },
     {
        "batch":{
           "business_id":"02b61320-ecf3-11e5-a83a-020000ed147d",
           "exchange_coupon_redeem_fee":0,
           "id":"17ec7187-3bd2-11e7-8cbf-020000ed147d",
           "loyalty_id":"02b6a028-ecf3-11e5-a83a-020000ed147d",
           "public_description":"Coupon description",
           "public_title":"Coupon name",
           "recommendation_fee_amount":1,
           "recommendation_fee_bonuses_currency":"USD",
           "recommendation_fee_promotional_bonuses_expire_date":"2017-06-19",
           "recommendation_fee_promotional_bonuses_expire_type":"date",
           "recommendation_fee_promotional_bonuses_expire_value":0,
           "recommendation_fee_type":"promotional-bonuses",
           "share_allowed":1,
           "type":"certificate"
        },
        "code":"192059545592",
        "id":"46884efe-4d1b-11e7-8cbf-020000ed147d",
        "status":"open"
     }
  ]

Remarks:
In the case of a well-formed request and correct data, the response contains the array of objects-"coupons"

Adding coupon to customer wallet

Request for adding coupon to customer wallet

URL:
- /term/coupons/{{id}}/{{id_type}}/add
- /term/coupons/{{id}}/add - simplified method without specifying the ID type; supports only the following ID types: phone number in international format ('+' at the beginning of the phone number is mandatory), plastic card number, code of the order ('@' at the beginning of the code is mandatory) or QR code from the inCust app.
Method: POST
URL parameters:
- id: customer ID. In the case of the simplified method, it can be only a phone number in international format ('+' at the beginning of the phone number is mandatory), plastic card number, code of the order ('@' at the beginning of the code is mandatory) or QR code from the inCust app
- id_type: the type of the customer ID. Currently, the following types are supported in the system:
  - phone - phone number in international format ('+' at the beginning of the phone number is mandatory)
  - qr - QR code from the inCust app
  - email - customer e-mail (the one used to login to inCust)
  - card - plastic card number
  - temporary-card - customer code, generated by the inCust Terminal app in Steward mode
  - id - customer ID in the inCust system
  - social-network - customer ID in the social network, with FB_ prefix for Facebook and G_ for Google
  - ssn - social security number for the US citizens and residents
  - itin - individual taxpayer's number
Data parameters:
- an array of objects with the code field wich contains the coupon code, for example [{ "code": 246990359478 }, { "code": 192059545592 }]

Sample request:

  {
     "method":"POST",
     "url":"https://api.incust.com/v1/term/coupons/+1112233444/phone/add",
     "headers":{
        "Content-Type":"application/json",
        "Accept-Language":"en",
        "Authorization":"bearer eyJ0ZXJtaW5hbF9pZCI6IjAyYmE2YmVhLWVjZjMtMTFlNS1hODNhLTAyMDAwMGVkMTQ3ZCIsInZlcnNpb24iOjF9.C6RfdA.1hcHsBbsYA9Ez38YEhdEJKBvNN8"
     },
     "data":[
        { "code": 246990359478 },
        { "code": 192059545592 }
     ]
  }

Sample response:

  {
      "codes":[
         {
            "code":"246990359478",
            "valid":true
         },
         {
            "code":"192059545592",
            "valid":true
         }
      ],
      "coupons":[
         {
            "batch":{
               "business_id":"02b61320-ecf3-11e5-a83a-020000ed147d",
               "exchange_coupon_redeem_fee":0,
               "id":"3dc71a1f-1483-11e7-898a-020000ed147d",
               "image":"https://api.incust.com/static/13/87/5540302b42ea96fcfe833c43312a.jpeg",
               "loyalty_id":"02b6a028-ecf3-11e5-a83a-020000ed147d",
               "public_description":"Coupon description",
               "public_title":"Coupon name",
               "share_allowed":0,
               "type":"check-modifier"
            },
            "code":"246990359478",
            "id":"4081a81a-1483-11e7-898a-020000ed147d",
            "status":"open"
         },
         {
            "batch":{
               "business_id":"02b61320-ecf3-11e5-a83a-020000ed147d",
               "exchange_coupon_redeem_fee":0,
               "id":"17ec7187-3bd2-11e7-8cbf-020000ed147d",
               "loyalty_id":"02b6a028-ecf3-11e5-a83a-020000ed147d",
               "public_description":"Coupon description",
               "public_title":"Coupon name",
               "recommendation_fee_amount":1,
               "recommendation_fee_bonuses_currency":"USD",
               "recommendation_fee_promotional_bonuses_expire_date":"2017-06-19",
               "recommendation_fee_promotional_bonuses_expire_type":"date",
               "recommendation_fee_promotional_bonuses_expire_value":0,
               "recommendation_fee_type":"promotional-bonuses",
               "share_allowed":1,
               "type":"certificate"
            },
            "code":"192059545592",
            "id":"46884efe-4d1b-11e7-8cbf-020000ed147d",
            "status":"open"
         }
      ],
      "message":"Coupons and certificates have been added to the customer's wallet in the amount of 2 pieces. Of these, at the point of sale, the customer will be able to see and use 2 pieces.\nCustomer can view the full list of coupons and certificates in their wallet in the inCust mobile app."
  }

Remarks:
In the case of a well-formed request and correct data, the response contains an object with fields:
- codes: an array of objects containing field:
  - code: coupon code
  - valid: coupon validity, values true or false
- coupons: an array of coupon objects

Using coupon of "certificate" type

Coupons of the "certificate" type allows one-time redeeming of reward by the customer. The reward can be bonus points, temporary bonus points (with a limited period of validity), replenishment of the customer account.

Using coupon of "certificate" type

URL:
- /term/coupons/{{id}}/{{id_type}}/redeem
- /term/coupons/{{id}}/redeem - simplified method without specifying the ID type; supports only the following ID types: phone number in international format ('+' at the beginning of the phone number is mandatory), plastic card number, code of the order ('@' at the beginning of the code is mandatory) or QR code from the inCust app.
Method: POST
URL parameters:
- id: customer ID. In the case of the simplified method, it can be only a phone number in international format ('+' at the beginning of the phone number is mandatory), plastic card number, code of the order ('@' at the beginning of the code is mandatory) or QR code from the inCust app
- id_type: the type of the customer ID. Currently, the following types are supported in the system:
  - phone - phone number in international format ('+' at the beginning of the phone number is mandatory)
  - qr - QR code from the inCust app
  - email - customer e-mail (the one used to login to inCust)
  - card - plastic card number
  - temporary-card - customer code, generated by the inCust Terminal app in Steward mode
  - id - customer ID in the inCust system
  - social-network - customer ID in the social network, with FB_ prefix for Facebook and G_ for Google
  - ssn - social security number for the US citizens and residents
  - itin - individual taxpayer's number

Data parameters:

an array of objects with the id field, which contains coupon id, for example [{ "id": "4081a81a-1483-11e7-898a-020000ed147d" }, { "id": "46884efe-4d1b-11e7-8cbf-020000ed147d" }]

{
 "method":"POST",
 "url":"https://api.incust.com/v1/term/coupons/+1112233444/phone/redeem",
 "headers":{
    "Content-Type":"application/json",
    "Accept-Language":"en",
    "Authorization":"bearer eyJ0ZXJtaW5hbF9pZCI6IjAyYmE2YmVhLWVjZjMtMTFlNS1hODNhLTAyMDAwMGVkMTQ3ZCIsInZlcnNpb24iOjF9.C6RfdA.1hcHsBbsYA9Ez38YEhdEJKBvNN8"
 },
 "data":[
    { "id": "4081a81a-1483-11e7-898a-020000ed147d" },
    { "id": "46884efe-4d1b-11e7-8cbf-020000ed147d" }
 ]
}

Sample response:

  [
     {
        "batch":{
           "business_id":"02b61320-ecf3-11e5-a83a-020000ed147d",
           "exchange_coupon_redeem_fee":6,
           "id":"79e43946-3bd4-11e7-8cbf-020000ed147d",
           "image":"https://api.incust.com/static/d3/3b/a235a2fb4af7960dcb3691c3cc54.jpeg",
           "loyalty_id":"02b6a028-ecf3-11e5-a83a-020000ed147d",
           "public_description":"Coupon description",
           "public_title":"Coupon name",
           "recommendation_fee_type":"none",
           "share_allowed":1,
           "type":"certificate"
        },
        "code":"131720042556",
        "id":"7a165695-3bd4-11e7-8cbf-020000ed147d",
        "redeemed":true,
        "status":"redeemed"
     },
     {
        "batch":{
           "business_id":"02b61320-ecf3-11e5-a83a-020000ed147d",
           "exchange_coupon_redeem_fee":6,
           "id":"79e43946-3bd4-11e7-8cbf-020000ed147d",
           "image":"https://api.incust.com/static/d3/3b/a235a2fb4af7960dcb3691c3cc54.jpeg",
           "loyalty_id":"02b6a028-ecf3-11e5-a83a-020000ed147d",
           "public_description":"Coupon description",
           "public_title":"Coupon name",
           "recommendation_fee_type":"none",
           "share_allowed":1,
           "type":"certificate"
        },
        "code":"131720042556",
        "id":"7a165695-3bd4-11e7-8cbf-020000ed147d",
        "redeemed":true,
        "status":"redeemed"
     }
  ]

Remarks:
In the case of a well-formed request and correct data, an array with objects of coupon type, the coupon object will additionally contain a redeemed field, containing the result of applying the coupon, possible values are true or false

Benefits

Benefits are some points or values, which are credited to customer accounts or to the bonus point account of the customer.
Bonus points can be temporary (expire after certain time) or regular, lifetime of which is not limited.

Crediting of customer account

The method lets you credit benefits to the customer's account.

Request for crediting of customer account

URL: /term/charge_benefits
Method: POST
URL parameters:
- no
Data parameters:
- id_type: the optional type of the customer ID. Currently, the following types are supported in the system:
```
- *phone* - phone number in international format (**'+'** at the beginning of the phone number is mandatory)
- *qr* - QR code from the inCust app
- *email* - customer e-mail (the one used to login to inCust)
- *card* - plastic card number
- *temporary-card* - customer code, generated by the inCust Terminal app in Steward mode
- *id* - customer ID in the inCust system
- *social-network* - customer ID in the social network, with **FB_** prefix for Facebook and **G_** for Google
- *ssn* - social security number for the US citizens and residents
- *itin* - individual taxpayer's number    
```
- id: customer ID. If the identifier type is not specified in id_type parameter, the value of id can be only a phone number in international format ('+' at the beginning of the phone number is mandatory), plastic card number, code of the order ('@' at the beginning of the code is mandatory) or QR code from the inCust app
- type: the type of the benefit; possible values are 'regular-bonuses', 'promotional-bonuses', 'special-account'
- special_account_id: id of customer account (for special-account benefit type)
- currency: currency code of bonus points as defined by ISO 4217 (for regular-bonuses, promotional-bonuses benefit type)
- amount: the amount of credited bonus points or benefits
- promotional_bonuses_expire_date: the final date (the specified date is not included, i.e. validity period until 0000 of the specified date) in YYYY-MM-DD format, until which the temporary bonus points expire (for promotional-bonuses benefit type)
- comment: comment

Sample request to credit bonus points:

  {
     "method":"POST",
     "url":"https://api.incust.com/v1/term/charge_benefits",
     "headers":{
        "Content-Type":"application/json",
        "Accept-Language":"en",
        "Authorization":"bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6ImRmNGYzNzJmLWM0NzktNDNkMi1iNDRhLTg3MDZiZWEyY2EwOSJ9.C5q8aw.KasPpXo01yFhoqei_M02VOLF6Fk"
     },
     "data":{
        "id": "+12401234567",
        "type": "regular-bonuses",
        "currency": "USD",
        "amount": 10,
        "comment": "Comment to operation"
     }
  }

Sample request to credit temporary bonus points:

  {
     "method":"POST",
     "url":"https://api.incust.com/v1/term/charge_benefits",
     "headers":{
        "Content-Type":"application/json",
        "Accept-Language":"en",
        "Authorization":"bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6ImRmNGYzNzJmLWM0NzktNDNkMi1iNDRhLTg3MDZiZWEyY2EwOSJ9.C5q8aw.KasPpXo01yFhoqei_M02VOLF6Fk"
     },
     "data":{
        "id": "+12401234567",
        "type": "promotional-bonuses",
        "promotional_bonuses_expire_date": "2018-10-09",
        "currency": "USD",
        "amount": 20,
        "comment": "Comment to operation"
     }
  }

Sample request to credit the customer account:

  {
     "method":"POST",
     "url":"https://api.incust.com/v1/term/charge_benefits",
     "headers":{
        "Content-Type":"application/json",
        "Accept-Language":"en",
        "Authorization":"bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6ImRmNGYzNzJmLWM0NzktNDNkMi1iNDRhLTg3MDZiZWEyY2EwOSJ9.C5q8aw.KasPpXo01yFhoqei_M02VOLF6Fk"
     },
     "data":{
        "id": "+12401234567",
        "type": "special-account",
        "special_account_id": "1118c8d9-360e-4edc-9a32-d6187b833222",
        "amount": 10,
        "comment": "Comment to operation"
     }
  }

Sample response:

  {
      "amount":35,
      "amount_to_pay":34,
      "bonus_account_id":"4cf87c86-ff18-11e6-bfd1-020000ed147d",
      "bonuses_added":3.4,
      "bonuses_on_account":3.4,
      "bonuses_redeemed":1,
      "business_id":"87f710f5-b174-11e6-bfd1-020000ed147d",
      "comment":"",
      "currency":"USD",
      "discount_amount":0,
      "id":"a15ebe59-fff6-11e6-bfd1-020000ed147d",
      "info":"{\"promotional_bonuses_expire_date\":\"2018-10-09\",\"type\":\"promotional-bonuses\",\"currency\":\"USD\",\"id\":\"+12401234567\",\"comment\":\"Comment to operation\",\"amount\":20}",
      "loyalty_id":"87f74cd0-b174-11e6-bfd1-020000ed147d",
      "online":1,
      "payment_type":"currency",
      "processed":"2017-03-03T09:49:01Z",
      "sms":1,
      "special_account_amount":0,
      "special_account_id":null,
      "terminal_id":"df4f372f-c479-43d2-b44a-8706bea2ca09",
      "transaction_id":null,
      "type": "bonus-add",
      "user_id":"30ed9ec1-593d-4b68-b090-660c0488a95f"
  }

Remarks:
In the case of a well-formed request and correct data, the response contains the object with information about the performed operation.
- id: ID of the check or transaction
- amount: amount of operation
- amount_to_pay: amount to pay
- bonuses_added: bonus points, credited to the bonus point account
- bonuses_on_account: bonus points currently on account
- bonuses_redeemed: bonus points redeemed
- comment: comment to transaction

Tourist card (prepaid services card)

A tourist card is a virtual card that contains the set of prepaid services.

A tourist card object contains the following fields:

- **id**: id of a tourist card
- **code**: tourist card code
- **public_title**: public title of the card
- **public_description**: public description of the card
- **image**: card image, the link to the picture
- **active**: the flag that specifies if the card has been activated
- **activated_dt**: date and time of activation in `'YYYY-MM-DD HH-mm-ss'` format
- **expire_dt**: date and time of expiration in `'YYYY-MM-DD HH-mm-ss'` format
- **valid**: the flag that specifies if the card is valid
- **accounts**: the array of account objects; contains information about accounts, available with the card; each account object contains the following fields 
    - **id**: id of the account
    - **public_title**: public name of the account
    - **precision**: precision of the acount, the possible values are `'integer'`, `'two-decimal-places'`, `'three-decimal-places'`  
    - **amount**: account balance
- **services**: array of the service objects; contains information about services, avaialble with the card; each service object contains the following fields
    - **id**: id of the service
    - **public_title**: public name of the service
    - **public_description**: public description of the service
    - **category**: service category object; contains information about the category, to which the service belongs; the service category object contains the following fields
        - **id**: category id  
        - **public_title**: public name of the service category 
    - **decrement_step**: account decrement step
    - **usage_limit_per_loyalty**: limit of the number of uses within the loyalty program (`0` for unlimited use)  
    - **usage_limit_per_loyalty_period_type**: type of restriction period; the possible values are `'all-card-time'`, `'hour'`, `'day'`, `'month'`  
    - **usage_limit_per_loyalty_period_value**: size of restriction period (e.g., when type is set to 'day', 7 stands for a week)
    - **usage_limit_per_pos**: limit of the number of uses within the point of sale (`0` for unlimited use) 
    - **usage_limit_per_pos_period_type**: type of restriction period; the possible values are `'all-card-time'`, `'hour'`, `'day'`, `'month'`  
    - **usage_limit_per_pos_period_value**: size of restriction period (e.g., when type is set to 'day', 7 stands for a week)
    - **used_times**: the number of times the service was used with the card
    - **available_times**: the number of available uses, expected value
    - **available_amount**: account balance
    - **available_now**: availability of the service right now

List of customer's tourist cards

The list includes all tourist cards, present in the customer's wallet.

Request to retrieve the list of tourist cards of the customer

URL:
- /term/tour_card/{{id}}/{{id_type}}/cards
- /term/tour_card/{{id}}/cards - simplified method without specifying the ID type; supports only the following ID types: phone number in international format ('+' at the beginning of the phone number is mandatory), plastic card number, code of the order ('@' at the beginning of the code is mandatory) or QR code from the inCust app.
Method: GET
URL parameters:
- id: customer ID. In the case of the simplified method, it can be only a phone number in international format ('+' at the beginning of the phone number is mandatory), plastic card number, code of the order ('@' at the beginning of the code is mandatory) or QR code from the inCust app
- id_type: the type of the customer ID. Currently, the following types are supported in the system:
  - phone - phone number in international format ('+' at the beginning of the phone number is mandatory)
  - qr - QR code from the inCust app
  - email - customer e-mail (the one used to login to inCust)
  - card - plastic card number
  - temporary-card - customer code, generated by the inCust Terminal app in Steward mode
  - id - customer ID in the inCust system
  - social-network - customer ID in the social network, with FB_ prefix for Facebook and G_ for Google
  - ssn - social security number for the US citizens and residents
  - itin - individual taxpayer's number
Data parameters:
- no

Sample request:

  {
     "method":"GET",
     "url":"https://api.incust.com/v1/term/tour_card/+12401234567/cards,
     "headers":{
        "Content-Type":"application/json",
        "Authorization":"bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6IjAyYmE2YmVhLWVjZjMtMTFlNS1hODNhLTAyMDAwMGVkMTQ3ZCJ9.C7UthA.wvYZuI-vrJymIlEI15EHdT7kcIY"
     }
  }

Sample response:

  [
      {
          "accounts": [
              {
                  "amount": 0,
                  "id": "2a72c955-5bed-4988-802b-3841f92ca016",
                  "precision": "integer",
                  "public_title": "Account name"
              }
          ],
          "activated_dt": "2018-06-20T09:57:47.225000Z",
          "active": 1,
          "code": "570237733572",
          "expire_dt": "2018-08-20T09:57:47.225000Z",
          "id": "609d58d7-7470-11e8-a7b9-020000ed147d",
          "public_title": "Card title",
          "public_description": "Card description",
          "services": [
              {
                  "available_amount": 0,
                  "available_now": 0,
                  "available_times": 0,
                  "category": {
                      "id": "6a641932-5672-421f-aaec-9760bc8cf4fe",
                      "public_title": "Service category name"
                  },
                  "decrement_step": 5,
                  "id": "78c3f28f-bdbd-47df-9e11-e039e10f19ea",
                  "public_title": "Service name",
                  "public_description": "Service description",
                  "usage_limit_per_loyalty": 0,
                  "usage_limit_per_loyalty_period_type": "all-card-time",
                  "usage_limit_per_loyalty_period_value": 0,
                  "usage_limit_per_pos": 3,
                  "usage_limit_per_pos_period_type": "hour",
                  "usage_limit_per_pos_period_value": 1,
                  "used_times": 10
              }
          ],
          "valid": 1
      }
  ]

Remarks:
In the case of a well-formed request and correct data, the response contains the array of tourist card objects.

Add tourist card to customer's wallet

This method lets you add a tourist card to the customer's wallet. The method returns the list of tourist cards, added to the wallet.

Request to add a tourist card to the customer's wallet

URL:
- /term/tour_card/{{id}}/{{id_type}}/cards/add
- /term/tour_card/{{id}}/cards/add - simplified method without specifying the ID type; supports only the following ID types: phone number in international format ('+' at the beginning of the phone number is mandatory), plastic card number, code of the order ('@' at the beginning of the code is mandatory) or QR code from the inCust app.
Method: POST
URL parameters:
- id: customer ID. In the case of the simplified method, it can be only a phone number in international format ('+' at the beginning of the phone number is mandatory), plastic card number, code of the order ('@' at the beginning of the code is mandatory) or QR code from the inCust app
- id_type: the type of the customer ID. Currently, the following types are supported in the system:
  - phone - phone number in international format ('+' at the beginning of the phone number is mandatory)
  - qr - QR code from the inCust app
  - email - customer e-mail (the one used to login to inCust)
  - card - plastic card number
  - temporary-card - customer code, generated by the inCust Terminal app in Steward mode
  - id - customer ID in the inCust system
  - social-network - customer ID in the social network, with FB_ prefix for Facebook and G_ for Google
  - ssn - social security number for the US citizens and residents
  - itin - individual taxpayer's number
Data parameters:
- card_id: id of the tourist card being added

Sample request:

  {
     "method":"POST",
     "url":"https://api.incust.com/v1/term/tour_card/+12401234567/cards/add",
     "headers":{
        "Content-Type":"application/json",
        "Accept-Language":"en",
        "Authorization":"bearer eyJ0ZXJtaW5hbF9pZCI6IjAyYmE2YmVhLWVjZjMtMTFlNS1hODNhLTAyMDAwMGVkMTQ3ZCIsInZlcnNpb24iOjF9.C6RfdA.1hcHsBbsYA9Ez38YEhdEJKBvNN8"
     },
     "data":{
        "card_id": "609d58d7-7470-11e8-a7b9-020000000000"
     }
  }

Sample response:

  [
      {
          "accounts": [
              {
                  "amount": 0,
                  "id": "2a72c955-5bed-4988-802b-3841f92ca016",
                  "precision": "integer",
                  "public_title": "Account name"
              }
          ],
          "activated_dt": "2018-06-20T09:57:47.225000Z",
          "active": 1,
          "code": "570237733572",
          "expire_dt": "2018-08-20T09:57:47.225000Z",
          "id": "609d58d7-7470-11e8-a7b9-020000ed147d",
          "public_title": "Card title",
          "public_description": "Card description",
          "services": [
              {
                  "available_amount": 0,
                  "available_now": 0,
                  "available_times": 0,
                  "category": {
                      "id": "6a641932-5672-421f-aaec-9760bc8cf4fe",
                      "public_title": "Service category name"
                  },
                  "decrement_step": 5,
                  "id": "78c3f28f-bdbd-47df-9e11-e039e10f19ea",
                  "public_title": "Service name",
                  "public_description": "Service description",
                  "usage_limit_per_loyalty": 0,
                  "usage_limit_per_loyalty_period_type": "all-card-time",
                  "usage_limit_per_loyalty_period_value": 0,
                  "usage_limit_per_pos": 3,
                  "usage_limit_per_pos_period_type": "hour",
                  "usage_limit_per_pos_period_value": 1,
                  "used_times": 10
              }
          ],
          "valid": 1
      }
  ]

Remarks:
In the case of a well-formed request and correct data, the response contains the array of tourist card objects.

Retrieval of data about tourist card

Search for the tourist card by code and retrieval of information about this card

Request to retrieve information about the tourist card

URL:
- /term/tour_card/{{id}}/{{id_type}}/cards/code
- /term/tour_card/{{id}}/cards/code - simplified method without specifying the ID type; supports only the following ID types: phone number in international format ('+' at the beginning of the phone number is mandatory), plastic card number, code of the order ('@' at the beginning of the code is mandatory) or QR code from the inCust app.
- /term/tour_card/cards/code - without customer identification.
Method: POST
URL parameters:
- id: customer ID. In the case of the simplified method, it can be only a phone number in international format ('+' at the beginning of the phone number is mandatory), plastic card number, code of the order ('@' at the beginning of the code is mandatory) or QR code from the inCust app
- id_type: the type of the customer ID. Currently, the following types are supported in the system:
  - phone - phone number in international format ('+' at the beginning of the phone number is mandatory)
  - qr - QR code from the inCust app
  - email - customer e-mail (the one used to login to inCust)
  - card - plastic card number
  - temporary-card - customer code, generated by the inCust Terminal app in Steward mode
  - id - customer ID in the inCust system
  - social-network - customer ID in the social network, with FB_ prefix for Facebook and G_ for Google
  - ssn - social security number for the US citizens and residents
  - itin - individual taxpayer's number
Data parameters:
- card_id: ID of the tourist card being added

Sample request:

  {
     "method":"POST",
     "url":"https://api.incust.com/v1/term/tour_card/+12401234567/cards/code",
     "headers":{
        "Content-Type":"application/json",
        "Accept-Language":"en",
        "Authorization":"bearer eyJ0ZXJtaW5hbF9pZCI6IjAyYmE2YmVhLWVjZjMtMTFlNS1hODNhLTAyMDAwMGVkMTQ3ZCIsInZlcnNpb24iOjF9.C6RfdA.1hcHsBbsYA9Ez38YEhdEJKBvNN8"
     },
     "data":{
        "code": "570237733572"
     }
  }

Sample response:

  {
      "accounts": [
          {
              "amount": 0,
              "id": "2a72c955-5bed-4988-802b-3841f92ca016",
              "precision": "integer",
              "public_title": "Account name"
          }
      ],
      "activated_dt": "2018-06-20T09:57:47.225000Z",
      "active": 1,
      "code": "570237733572",
      "expire_dt": "2018-08-20T09:57:47.225000Z",
      "id": "609d58d7-7470-11e8-a7b9-020000ed147d",
      "public_title": "Card title",
      "public_description": "Card description",
      "services": [
          {
              "available_amount": 0,
              "available_now": 0,
              "available_times": 0,
              "category": {
                  "id": "6a641932-5672-421f-aaec-9760bc8cf4fe",
                  "public_title": "Service category name"
              },
              "decrement_step": 5,
              "id": "78c3f28f-bdbd-47df-9e11-e039e10f19ea",
              "public_title": "Service name",
              "public_description": "Service description",
              "usage_limit_per_loyalty": 0,
              "usage_limit_per_loyalty_period_type": "all-card-time",
              "usage_limit_per_loyalty_period_value": 0,
              "usage_limit_per_pos": 3,
              "usage_limit_per_pos_period_type": "hour",
              "usage_limit_per_pos_period_value": 1,
              "used_times": 10
          }
      ],
      "valid": 1
  }

Remarks:
In the case of a well-formed request and correct data, the response contains the tourist card object.

Use of service from tourist card

One-time use of the service, available according to the tourist card

Request to use the service from the tourist card

URL:
- /term/tour_card/{{id}}/{{id_type}}/cards/service/use
- /term/tour_card/{{id}}/cards/service/use - simplified method without specifying the ID type; supports only the following ID types: phone number in international format ('+' at the beginning of the phone number is mandatory), plastic card number, code of the order ('@' at the beginning of the code is mandatory) or QR code from the inCust app.
- /term/tour_card/cards/service/use - without customer identification
Method: POST
URL parameters:
- id: customer ID. In the case of the simplified method, it can be only a phone number in international format ('+' at the beginning of the phone number is mandatory), plastic card number, code of the order ('@' at the beginning of the code is mandatory) or QR code from the inCust app
- id_type: the type of the customer ID. Currently, the following types are supported in the system:
  - phone - phone number in international format ('+' at the beginning of the phone number is mandatory)
  - qr - QR code from the inCust app
  - email - customer e-mail (the one used to login to inCust)
  - card - plastic card number
  - temporary-card - customer code, generated by the inCust Terminal app in Steward mode
  - id - customer ID in the inCust system
  - social-network - customer ID in the social network, with FB_ prefix for Facebook and G_ for Google
  - ssn - social security number for the US citizens and residents
  - itin - individual taxpayer's number
Data parameters:
- card_id: ID of the tourist card being added
- service_id: ID of the service

Sample request:

  {
     "method":"POST",
     "url":"https://api.incust.com/v1/term/tour_card/+12401234567/cards/service/use",
     "headers":{
        "Content-Type":"application/json",
        "Accept-Language":"en",
        "Authorization":"bearer eyJ0ZXJtaW5hbF9pZCI6IjAyYmE2YmVhLWVjZjMtMTFlNS1hODNhLTAyMDAwMGVkMTQ3ZCIsInZlcnNpb24iOjF9.C6RfdA.1hcHsBbsYA9Ez38YEhdEJKBvNN8"
     },
     "data":{
        "card_id": "609d58d7-7470-11e8-a7b9-020000000000",
        "service_id": "709d58d7-7470-11e8-a7b9-020000000000"
     }
  }

Sample response:

  {
      "accounts": [
          {
              "amount": 0,
              "id": "2a72c955-5bed-4988-802b-3841f92ca016",
              "precision": "integer",
              "public_title": "Account name"
          }
      ],
      "activated_dt": "2018-06-20T09:57:47.225000Z",
      "active": 1,
      "code": "570237733572",
      "expire_dt": "2018-08-20T09:57:47.225000Z",
      "id": "609d58d7-7470-11e8-a7b9-020000ed147d",
      "public_title": "Card title",
      "public_description": "Card description",
      "services": [
          {
              "available_amount": 0,
              "available_now": 0,
              "available_times": 0,
              "category": {
                  "id": "6a641932-5672-421f-aaec-9760bc8cf4fe",
                  "public_title": "Service category name"
              },
              "decrement_step": 5,
              "id": "78c3f28f-bdbd-47df-9e11-e039e10f19ea",
              "public_title": "Service name",
              "public_description": "Service description",
              "usage_limit_per_loyalty": 0,
              "usage_limit_per_loyalty_period_type": "all-card-time",
              "usage_limit_per_loyalty_period_value": 0,
              "usage_limit_per_pos": 3,
              "usage_limit_per_pos_period_type": "hour",
              "usage_limit_per_pos_period_value": 1,
              "used_times": 10
          }
      ],
      "valid": 1
  }

Remarks:
In the case of a well-formed request and correct data, the service will be "used", and the response will contain the tourist card object.

Store

The loyalty program can have the Store activated. In this store, customers can place orders using the mobile app.
With the help of the Terminal API, orders can be processed, shipped or canceled.

An Order object contains the following fields:

id: Order ID
created: date and time of order creation (in 'YYYY-MM-DD HH-mm-ss' format)
number: order number
payment_method: payment method:
- payment-at-checkout - paid during placement
- payment-upon-receipt - paid upon delivery
paid: indicator of the order's payment status
status: order status:
- created - created
- inprocess - in processing
- delivered - shipped/delivered
- canceled - canceled
user_id: ID of the customer
check: check object, described in the Check Preparation section. This object is used for the further payment for the order and for finalizing order transaction (Save check with finalization).
transaction: an array of transaction objects, bound with the order (see description of the object in the Receive the list of transactions section)
shipping: Order delivery object, includes the following fields:
- delivery: delivery method object
- ship_to: delivery address object
- delivery_date: date of delivery
- delivery_time: time of delivery

List of customer's orders

Paginated list of customer's orders, filtered by date and payment status.

Request to retrieve the list of a customer's orders

URL:
- /online_store/{id}/{id_type}/orders
- /term/online_store/{id}/orders - simplified method without specifying the ID type (supports only the following ID types: phone number in international format ('+' at the beginning of the phone number is mandatory), plastic card number, code of the order ('@' at the beginning of the code is mandatory) or QR code from the inCust app.
Method: GET
URL parameters:
- id: customer ID. In the case of the simplified method, it can be only a phone number in international format ('+' at the beginning of the phone number is mandatory), plastic card number, code of the order ('@' at the beginning of the code is mandatory) or QR code from the inCust app
- id_type: the type of the customer ID. Currently, the following types are supported in the system:
  - phone - phone number in international format ('+' at the beginning of the phone number is mandatory)
  - qr - QR code from the inCust app
  - email - customer e-mail (the one used to login to inCust)
  - card - plastic card number
  - temporary-card - customer code, generated by the inCust Terminal app in Steward mode
  - id - customer ID in the inCust system
  - social-network - customer ID in the social network, with FB_ prefix for Facebook and G_ for Google
  - ssn - social security number for the US citizens and residents
  - itin - individual taxpayer's number
- date_from, type 'string', date and time in YYYY-MM-DD[T]HH:mm:ss[Z] format
- date_to, type 'string', date and time in YYYY-MM-DD[T]HH:mm:ss[Z] format
- page, type integer, the page in pagination, the count of pages starts with 1
- count, type integer, the number of elements on the page,
- not_paid_only, type boolean, return only unpaid orders
Data parameters:
- none

Sample request:

  {
     "method":"GET",
     "url":"https://api.incust.com/v1/term/online_store/+12401234567/orders?date_from=2016-03-09T22:00:00Z&date_to=2017-03-10T21:59:59Z&page=1&count=3&not_paid_only=true",
     "headers":{
        "Content-Type":"application/json",
        "Authorization":"bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6IjAyYmE2YmVhLWVjZjMtMTFlNS1hODNhLTAyMDAwMGVkMTQ3ZCJ9.C7UthA.wvYZuI-vrJymIlEI15EHdT7kcIY"
     }
  }

Remarks:
In the case of a well-formed request and correct data, a response contains an object with two fields:
- orders: array of order objects
- total: the total number of elements in the response array

List of orders

Paginated list of orders, filtered by date and payment status.

Request to retrieve the list of orders

URL:
- /term/online_store/orders
Method: GET
URL parameters:
- date_from, type 'string', date and time in YYYY-MM-DD[T]HH:mm:ss[Z] format
- date_to, type 'string', date and time in YYYY-MM-DD[T]HH:mm:ss[Z] format
- page, type integer, the page in pagination, the count of pages starts with 1
- count, type integer, the number of elements on the page,
- not_paid_only, type boolean, return only unpaid orders
Data parameters:
- none

Sample request:

  {
     "method":"GET",
     "url":"https://api.incust.com/v1/term/online_store/orders?date_from=2016-03-09T22:00:00Z&date_to=2017-03-10T21:59:59Z&page=1&count=3&not_paid_only=true",
     "headers":{
        "Content-Type":"application/json",
        "Authorization":"bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6IjAyYmE2YmVhLWVjZjMtMTFlNS1hODNhLTAyMDAwMGVkMTQ3ZCJ9.C7UthA.wvYZuI-vrJymIlEI15EHdT7kcIY"
     }
  }

Remarks:
In the case of a well-formed request and correct data, a response contains an object with two fields:
- orders: array of order objects
- total: the total number of elements in the response array

Retrieval of information about the order

Information about the order

Request for retrieval of order data

URL:
- /term/online_store/orders/{order_id}
Method: GET
URL parameters:
- order_id, type 'string', ID of the order
Data parameters:
- none

Sample request:

  {
     "method":"GET",
     "url":"https://api.incust.com/v1/term/online_store/orders/0009ce9d-4e4c-4aab-94ad-c82c5db1ceac",
     "headers":{
        "Content-Type":"application/json",
        "Authorization":"bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6IjAyYmE2YmVhLWVjZjMtMTFlNS1hODNhLTAyMDAwMGVkMTQ3ZCJ9.C7UthA.wvYZuI-vrJymIlEI15EHdT7kcIY"
     }
  }

Remarks:
In the case of a well-formed request and correct data, a response contains an order object

Changing the order status

The Terminal API lets you change the status of the order

Request to change the order status

URL:
- /term/online_store/orders/{order_id}
Method: PATCH
URL parameters:
- order_id, type 'string', ID of the order
Data parameters:
- status, type 'string', new order status:
  - inprocess - in processing
  - delivered - shipped/delivered
  - canceled - canceled

Sample request:

  {
     "method":"PATCH",
     "url":"https://api.incust.com/v1/term/online_store/orders/0009ce9d-4e4c-4aab-94ad-c82c5db1ceac",
     "headers":{
        "Content-Type":"application/json",
        "Authorization":"bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6IjAyYmE2YmVhLWVjZjMtMTFlNS1hODNhLTAyMDAwMGVkMTQ3ZCJ9.C7UthA.wvYZuI-vrJymIlEI15EHdT7kcIY"
     },
     "data":{
        "status":"delivered"
     }
  }

Remarks:
In the case of a well-formed request and correct data, the order status will be changed, and the response will contain an order object

Jobs

In the inCust system, it is possible to define jobs for external modules and devices (Fuel station pumps, charging stations, parkings etc.).
Jobs can be linked to a check or be an independent object, which can be linked to a check later.

Job object

A job is a complex object, the data of which depend on the type (fuel delivery, electric charging etc.) of the job being executed.

example of job information:

{
  "auto_capture_parent_transaction": true,
  "auto_start": true,
  "created": "2020-05-06T08:32:12.369000Z",
  "details": {
      "fuel": {
          "captured_amount": 0,
          "captured_price": 0,
          "captured_volume": 0,
          "controller": "0034003A0034003A0034003A",
          "controller_id": "e5177fc3-fc52-48df-a218-4414e67c48a5",
          "controller_type": "pts-2",
          "filled_amount": 0.0,
          "filled_volume": 0.0,
          "filling_doze": 1000.0,
          "filling_price": 10.0,
          "filling_price_currency": "UAH",
          "filling_price_type": "currency",
          "filling_type": "amount",
          "goods_code": "Petrol 95",
          "nozzle": "4",
          "nozzle_id": "4f89b9d8-3455-4d05-abcc-2c177c6a180a",
          "pump": "1",
          "pump_id": "4f54fe83-3c53-49b2-bf03-e7f37d342caa",
          "status": "filling-finished"
      },
      "source_data": {
          "auto_start": true,
          "details": {
              "fuel": {
                  "filling_doze": 1000.0,
                  "filling_price": 10.0,
                  "filling_price_currency": "UAH",
                  "filling_price_type": "currency",
                  "filling_type": "amount",
                  "nozzle_id": "4f89b9d8-3455-4d05-abcc-2c177c6a180a"
              }
          },
          "type": "fuel"
      },
      "start": {
          "command": "job_starting",
          "comment": "auto_start",
          "processed": "2020-05-06 08:32:15"
      }
  },
  "finalize_transaction_id": "6c3988e0-8f74-11ea-b744-020000ed147d",
  "finished": "2020-05-06T08:34:11.167000Z",
  "id": "dd116021-e344-486e-90ae-325ed9570f05",
  "loyalty_id": "b4e262e7-0d35-11e6-bfd1-020000ed147d",
  "pos_id": "b4e31526-0d35-11e6-bfd1-020000ed147d",
  "started": "2020-05-06T08:32:15.388000Z",
  "status": "finished",
  "terminal_id": "b40961ee-0d35-11e6-bfd1-020000ed147d",
  "transaction_id": "12374b93-8f74-11ea-b744-020000ed147d",
  "type": "fuel"
}

id: unique Id of the job
type: type of payment
- fuel - fuel delivery
status: job status
- created - job has been created
- starting - job is being started for processing
- inprocess - job is being processed
- stopping - job is being forcefully stopped
- finished - job is finished
created: Date and time of job creation in YYYY-MM-DD[T]HH:mm:ss[Z] format, UTC time zone
started: Date and time of job start in YYYY-MM-DD[T]HH:mm:ss[Z] format, UTC time zone
finished: Date and time of job completion in YYYY-MM-DD[T]HH:mm:ss[Z] format, UTC time zone
auto_start: the flag that is passed during creation of the job; it specifies that the system needs to take the job to processing right after it is created
auto_capture_parent_transaction: the flag that specifies that after the job is completed, the funds reserved for the check must be automatically written off (charged). The flag is applicable only when the job is created and linked to the check, for which the funds have been reserved.
transaction_id: unique Id of the transaction, to which the job is linked
finalize_transaction_id: unique identifier of the transaction, used to write off the previously reserved funds
finalize_transaction_failed: the indicator of the failure of writing off the previously reserved funds
finalize_transaction_errors: array of errors, caused by the attempt to write off the previously reserved funds. The error object is described in the transaction object
details: job detalization object (depends on the job type), contains the following fields:
- source_data: object with original job data
- fuel: an object that describes fuel delivery details (applicable only to tasks with the fuel type):
  - filling_price, type: number, price of one unit of fuel (e.g. liter or gallon)
  - filling_price_type, type: string, the type of the price of the unit of goods:
    - currency - payment with money
    - special-account - payment from the customer account
  - filling_price_currency, type: string, ISO code of the currency, in which the price of the unit of goods is specified
  - filling_price_special_account_id, type: string, the unique ID of the customer account, in which price of the unit of goods is specified
  - filling_price_unit, type: string, the unit in which the price of the unit of goods is specified
  - filling_type, type: string, type of doze of fuel that must be provided:
    - amount - filling doze is the cost of the fuel that must be provided
    - volume - filling doze is the amount of fuel that must be provided
  - filling_doze, type: number, the cost of the fuel that must be provided or amount of fuel that must be provided in units (liters, gallons), depends of filling_type
  - status: execution status
    - waiting-for-process - the job is waiting for the pump to perform
    - pump-is-offline - the pump is not connected or does not respond
    - pump-is-busy - the pump is busy with another job (another check is opened)
    - nozzle-not-taken-up - the pump doesn't have a picked (used) hose
    - wrong-nozzle-taken-up - the pump has another hose picked (used)
    - ready-for-filling - the pump is ready for fuel delivery
    - filling - fuel delivery in progress
    - filling-stopping - fuel delivery is being forcefully stopped
    - filling-finished - fuel delivery complete
    - filling-failed - failure during fuel delivery
  - filled_volume, type: number, the amount of fuel that was delivered
  - filled_amount, type: number, the cost of the fuel that was delivered
  - captured_price, type: number, the cost of the unit of volume in check
  - captured_volume, type: number, the volume of fuel, written off by check
  - captured_amount, type: number, the sum, written off by check
  - transaction, type: integer, transaction number, assigned by the controller
  - controller, type: string, internal identifier of the controller device
  - pump, type: integer, pump number
  - nozzle, type: integer, hose (nozzle) number
  - controller_id, type: string, unique Id of the controller
  - pump_id, type: string, unique Id of the pump
  - nozzle_id, type: string, unique Id of the fuel hose (nozzle)
  - goods_code, type: string, good code or SKU

Querying of jobs by check

One can retrieve the list of jobs, linked to the check.

Querying of jobs by check

URL:
- /term/jobs/check/{{id}}
Method: GET
URL parameters:
- id: unique Id of the transaction, the jobs of which should be retrieved
Data parameters:
- none

Sample request:

  { 
      "method":"POST",
      "url":"https://api.incust.com/v1/term/jobs/check/f5cfec5b-4cab-11ea-8e76-020000ed147d",
      "headers":{ 
          "Content-Type":"application/json",
          "Accept-Language":"en",
          "Authorization":"bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6ImRmNGYzNzJmLWM0NzktNDNkMi1iNDRhLTg3MDZiZWEyY2EwOSJ9.C5q8aw.KasPpXo01yFhoqei_M02VOLF6Fk"
      }
  }

Sample response:

  [
      {
          "auto_capture_parent_transaction": true,
          "auto_start": true,
          "created": "2020-03-11T16:35:48.715000Z",
          "details": {
              "fuel": {
                  "controller": "0034003A3435510938393730",
                  "controller_id": "e5177fc3-fc52-48df-a218-4414e67c48a5",
                  "controller_type": "pts-2",
                  "filled_amount": 0,
                  "filled_volume": 0,
                  "filling_doze": 3.0,
                  "filling_price": 1.0,
                  "filling_type": "amount",
                  "goods_code": "Petrol 95",
                  "nozzle": "4",
                  "nozzle_id": "4f89b9d8-3455-4d05-abcc-2c177c6a180a",
                  "pump": "1",
                  "pump_id": "4f54fe83-3c53-49b2-bf03-e7f37d342caa",
                  "status": "waiting-for-process"
              },
              "source_data": {
                  "auto_start": true,
                  "details": {
                      "fuel": {
                          "filling_doze": 3.0,
                          "filling_price": 1.0,
                          "filling_type": "amount",
                          "nozzle_id": "4f89b9d8-3455-4d05-abcc-2c177c6a180a"
                      }
                  },
                  "type": "fuel"
              },
              "start": {
                  "command": "job_starting",
                  "comment": "auto_start",
                  "processed": "2020-03-11 16:41:06"
              }
          },
          "id": "7e1d3313-c7c8-4f5c-b4ba-1e22f75c571b",
          "started": "2020-03-11T16:41:06.365000Z",
          "status": "starting",
          "transaction_id": "5a3475e8-63b6-11ea-8e76-020000ed147d",
          "type": "fuel"
      }
  ]

Remarks:
In the case of a well-formed request and correct data, the response contains the array of job objects.

Creation of job and linking it to check

It is possible to create jobs and link them to a previously created check.

Request for creation of of job and linking it to check

URL:
- /term/jobs/check/{{id}}
Method: POST
URL parameters:
- id: unique Id of the transaction, to which the new job must be added
Data parameters:
- An object of the job, which must be created and linked to the check

Sample request:

  { 
      "method":"POST",
      "url":"https://api.incust.com/v1/term/jobs/check/fa2d893e-47ef-11ea-8e76-020000ed147d",
      "headers":{ 
          "Content-Type":"application/json",
          "Accept-Language":"en",
          "Authorization":"bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6ImRmNGYzNzJmLWM0NzktNDNkMi1iNDRhLTg3MDZiZWEyY2EwOSJ9.C5q8aw.KasPpXo01yFhoqei_M02VOLF6Fk"
      },
      "data": {
          "type": "fuel",
          "auto_capture_parent_transaction": false,
          "details": {
              "fuel": {
                  "nozzle_id": "ae456b8e-28f9-43c5-8bf8-2f03b512e6a9",
                  "filling_price": 20.0,
                  "filling_type": "amount",
                  "filling_doze": 200.0
              }
          },
          "auto_start": false
       }
  }

Sample response:

  {
      "auto_capture_parent_transaction": false,
      "created": "2020-02-11T13:56:46.586000Z",
      "details": {
          "fuel": {
              "controller": "0034003A3435510938393730",
              "controller_id": "e5177fc3-fc52-48df-a218-4414e67c48a5",
              "controller_type": "pts-2",
              "filling_price": 20.0,
              "filling_type": "amount",
              "filling_doze": 200.0,
              "filled_amount": 0,
              "filled_volume": 0,
              "goods_code": "Petrol 95",
              "nozzle": 1,
              "nozzle_id": "ae456b8e-28f9-43c5-8bf8-2f03b512e6a9",
              "pump": 1,
              "pump_id": "4f54fe83-3c53-49b2-bf03-e7f37d342caa",
              "status": "waiting-for-process"
          },
          "source_data": {
              "auto_start": false,
              "details": {
                  "fuel": {
                      "nozzle_id": "ae456b8e-28f9-43c5-8bf8-2f03b512e6a9",
                      "filling_price": 20.0,
                      "filling_type": "amount",
                      "filling_doze": 200.0
                  }
              },
              "type": "fuel"
          }
      },
      "id": "2c6ab1f7-9c21-41fb-917a-d8ac1362e040",
      "status": "created",
      "transaction_id": "fa2d893e-47ef-11ea-8e76-020000ed147d",
      "type": "fuel"
  }

Remarks:
In the case of a well-formed request and correct data, the response will contain the object of the job which has been created.
Note:
- One can link the job that upon completion will automatically write off (charge) the reserved funds to the check with reservation of funds for check type.
  This possibility is defined by the auto_capture_parent_transaction job parameter. For other types of check, this parameter is ignored.
- The ask with the auto_capture_parent_transaction job parameter enabled cannot be combined with other tasks.

Creation of job

A job can be created as an independent object that can be linked to a check later.

Request for creation of job

URL:
- /term/jobs
Method: POST
URL parameters:
- none
Data parameters:
- An object of the job, which must be created

Sample request:

  { 
      "method":"POST",
      "url":"https://api.incust.com/v1/term/jobs",
      "headers":{ 
          "Content-Type":"application/json",
          "Accept-Language":"en",
          "Authorization":"bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6ImRmNGYzNzJmLWM0NzktNDNkMi1iNDRhLTg3MDZiZWEyY2EwOSJ9.C5q8aw.KasPpXo01yFhoqei_M02VOLF6Fk"
      },
      "data": {
          "type": "fuel",
          "auto_capture_parent_transaction": false,
          "details": {
              "fuel": {
                  "nozzle_id": "ae456b8e-28f9-43c5-8bf8-2f03b512e6a9",
                  "filling_price": 20.0,
                  "filling_type": "amount",
                  "filling_doze": 200.0
              }
          },
          "auto_start": false
       }
  }

Sample response:

  {
      "auto_capture_parent_transaction": false,
      "created": "2020-02-11T13:56:46.586000Z",
      "details": {
          "fuel": {
              "controller": "0034003A3435510938393730",
              "controller_id": "e5177fc3-fc52-48df-a218-4414e67c48a5",
              "controller_type": "pts-2",
              "filling_price": 20.0,
              "filling_type": "amount",
              "filling_doze": 200.0,
              "filled_amount": 0,
              "filled_volume": 0,
              "goods_code": "Petrol 95",
              "nozzle": 1,
              "nozzle_id": "ae456b8e-28f9-43c5-8bf8-2f03b512e6a9",
              "pump": 1,
              "pump_id": "4f54fe83-3c53-49b2-bf03-e7f37d342caa",
              "status": "waiting-for-process"
          },
          "source_data": {
              "auto_start": false,
              "details": {
                  "fuel": {
                      "nozzle_id": "ae456b8e-28f9-43c5-8bf8-2f03b512e6a9",
                      "filling_price": 20.0,
                      "filling_type": "amount",
                      "filling_doze": 200.0
                  }
              },
              "type": "fuel"
          }
      },
      "id": "2c6ab1f7-9c21-41fb-917a-d8ac1362e040",
      "status": "created",
      "type": "fuel"
  }

Remarks:
In the case of a well-formed request and correct data, the response will contain the object of the job which has been created.

Information about job

This method returns information about the job

Request for information about job

URL:
- /term/jobs/{{id}}
Method: GET
URL parameters:
- id: unique Id of the job
Data parameters:
- none

Sample request:

  { 
      "method":"POST",
      "url":"https://api.incust.com/v1/term/jobs/2c6ab1f7-9c21-41fb-917a-d8ac1362e040",
      "headers":{ 
          "Content-Type":"application/json",
          "Accept-Language":"en",
          "Authorization":"bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6ImRmNGYzNzJmLWM0NzktNDNkMi1iNDRhLTg3MDZiZWEyY2EwOSJ9.C5q8aw.KasPpXo01yFhoqei_M02VOLF6Fk"
      }
  }

Sample response:

  {
      "auto_capture_parent_transaction": false,
      "created": "2020-02-11T13:56:46.586000Z",
      "details": {
          "fuel": {
              "controller": "0034003A3435510938393730",
              "controller_id": "e5177fc3-fc52-48df-a218-4414e67c48a5",
              "controller_type": "pts-2",
              "filling_price": 20.0,
              "filling_type": "amount",
              "filling_doze": 200.0,
              "filled_amount": 0,
              "filled_volume": 0,
              "goods_code": "Petrol 95",
              "nozzle": 1,
              "nozzle_id": "ae456b8e-28f9-43c5-8bf8-2f03b512e6a9",
              "pump": 1,
              "pump_id": "4f54fe83-3c53-49b2-bf03-e7f37d342caa",
              "status": "waiting-for-process"
          },
          "source_data": {
              "auto_start": false,
              "details": {
                  "fuel": {
                      "nozzle_id": "ae456b8e-28f9-43c5-8bf8-2f03b512e6a9",
                      "filling_price": 20.0,
                      "filling_type": "amount",
                      "filling_doze": 200.0
                  }
              },
              "type": "fuel"
          }
      },
      "id": "2c6ab1f7-9c21-41fb-917a-d8ac1362e040",
      "status": "created",
      "transaction_id": "fa2d893e-47ef-11ea-8e76-020000ed147d",
      "type": "fuel"
  }

Remarks:
In the case of a well-formed request and correct data, the response will contain the object of the job

Starting of job

This method starts processing of the previously created job.

Request for starting of job

URL:
- /term/jobs/{{id}}/start
Method: POST
URL parameters:
- id: unique Id of the job
Data parameters:
- comment: comment

Sample request:

  { 
      "method":"POST",
      "url":"https://api.incust.com/v1/term/jobs/2c6ab1f7-9c21-41fb-917a-d8ac1362e040/start",
      "headers":{ 
          "Content-Type":"application/json",
          "Accept-Language":"en",
          "Authorization":"bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6ImRmNGYzNzJmLWM0NzktNDNkMi1iNDRhLTg3MDZiZWEyY2EwOSJ9.C5q8aw.KasPpXo01yFhoqei_M02VOLF6Fk"
      },
      "data": {
        "comment": "test"
       }
  }

Sample response:

  {
      "auto_capture_parent_transaction": false,
      "created": "2020-02-11T13:56:46.586000Z",
      "details": {
          "fuel": {
              "controller": "0034003A3435510938393730",
              "controller_id": "e5177fc3-fc52-48df-a218-4414e67c48a5",
              "controller_type": "pts-2",
              "filling_price": 20.0,
              "filling_type": "amount",
              "filling_doze": 200.0,
              "filled_amount": 0,
              "filled_volume": 0,
              "goods_code": "Petrol 95",
              "nozzle": 1,
              "nozzle_id": "ae456b8e-28f9-43c5-8bf8-2f03b512e6a9",
              "pump": 1,
              "pump_id": "4f54fe83-3c53-49b2-bf03-e7f37d342caa",
              "status": "waiting-for-process"
          },
          "source_data": {
              "auto_start": false,
              "details": {
                  "fuel": {
                      "nozzle_id": "ae456b8e-28f9-43c5-8bf8-2f03b512e6a9",
                      "filling_price": 20.0,
                      "filling_type": "amount",
                      "filling_doze": 200.0
                  }
              },
              "type": "fuel"
          }
      },
      "id": "2c6ab1f7-9c21-41fb-917a-d8ac1362e040",
      "status": "starting",
      "type": "fuel"
  }

Remarks:
In the case of a well-formed request and correct data, the response will contain the object of the job

Stopping of job

The method forcefully stops the job

Request for stopping of job

URL:
- /term/jobs/{{id}}/stop
Method: POST
URL parameters:
- id: unique Id of the job
Data parameters:
- comment: comment

Sample request:

  { 
      "method":"POST",
      "url":"https://api.incust.com/v1/term/jobs/2c6ab1f7-9c21-41fb-917a-d8ac1362e040/stop",
      "headers":{ 
          "Content-Type":"application/json",
          "Accept-Language":"en",
          "Authorization":"bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6ImRmNGYzNzJmLWM0NzktNDNkMi1iNDRhLTg3MDZiZWEyY2EwOSJ9.C5q8aw.KasPpXo01yFhoqei_M02VOLF6Fk"
      },
      "data": {
        "comment": "test"
       }
  }

Sample response:

  {
      "auto_capture_parent_transaction": false,
      "created": "2020-02-11T13:56:46.586000Z",
      "details": {
          "fuel": {
              "controller": "0034003A3435510938393730",
              "controller_id": "e5177fc3-fc52-48df-a218-4414e67c48a5",
              "controller_type": "pts-2",
              "filling_price": 20.0,
              "filling_type": "amount",
              "filling_doze": 200.0,
              "filled_amount": 0,
              "filled_volume": 0,
              "goods_code": "Petrol 95",
              "nozzle": 1,
              "nozzle_id": "ae456b8e-28f9-43c5-8bf8-2f03b512e6a9",
              "pump": 1,
              "pump_id": "4f54fe83-3c53-49b2-bf03-e7f37d342caa",
              "status": "waiting-for-process"
          },
          "source_data": {
              "auto_start": false,
              "details": {
                  "fuel": {
                      "nozzle_id": "ae456b8e-28f9-43c5-8bf8-2f03b512e6a9",
                      "filling_price": 20.0,
                      "filling_type": "amount",
                      "filling_doze": 200.0
                  }
              },
              "type": "fuel"
          }
      },
      "id": "2c6ab1f7-9c21-41fb-917a-d8ac1362e040",
      "status": "stopping",
      "type": "fuel"
  }

Remarks:
In the case of a well-formed request and correct data, the response will contain the object of the job

Linking of existing job to check

An earlier created job, not linked to the check, can be linked to the existing check at any moment of time.

Request for linking of existing job to check

URL:
- /term/jobs/{{id}}/transaction
Method: POST
URL parameters:
- id: unique Id of the job
Data parameters:
- id: unique Id of the transaction, to which the job must be linked

Sample request:

  { 
      "method":"POST",
      "url":"https://api.incust.com/v1/term/jobs/2c6ab1f7-9c21-41fb-917a-d8ac1362e040/transaction",
      "headers":{ 
          "Content-Type":"application/json",
          "Accept-Language":"en",
          "Authorization":"bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6ImRmNGYzNzJmLWM0NzktNDNkMi1iNDRhLTg3MDZiZWEyY2EwOSJ9.C5q8aw.KasPpXo01yFhoqei_M02VOLF6Fk"
      },
      "data": {
        "id": "fa2d893e-47ef-11ea-8e76-020000ed147d"
       }
  }

Sample response:

  {
      "auto_capture_parent_transaction": false,
      "created": "2020-02-11T13:56:46.586000Z",
      "details": {
          "fuel": {
              "controller": "0034003A3435510938393730",
              "controller_id": "e5177fc3-fc52-48df-a218-4414e67c48a5",
              "controller_type": "pts-2",
              "filling_price": 20.0,
              "filling_type": "amount",
              "filling_doze": 200.0,
              "filled_amount": 0,
              "filled_volume": 0,
              "goods_code": "Petrol 95",
              "nozzle": 1,
              "nozzle_id": "ae456b8e-28f9-43c5-8bf8-2f03b512e6a9",
              "pump": 1,
              "pump_id": "4f54fe83-3c53-49b2-bf03-e7f37d342caa",
              "status": "waiting-for-process"
          },
          "source_data": {
              "auto_start": false,
              "details": {
                  "fuel": {
                      "nozzle_id": "ae456b8e-28f9-43c5-8bf8-2f03b512e6a9",
                      "filling_price": 20.0,
                      "filling_type": "amount",
                      "filling_doze": 200.0
                  }
              },
              "type": "fuel"
          }
      },
      "id": "2c6ab1f7-9c21-41fb-917a-d8ac1362e040",
      "status": "created",
      "transaction_id": "fa2d893e-47ef-11ea-8e76-020000ed147d",
      "type": "fuel"
  }

Remarks:
In the case of a well-formed request and correct data, the response will contain the object of the job

Fuel and energy

In the inCust platform, one can plug external controllers, which manage fuel pumps and charging stations.

Detailed information about state of fuel pump or charging station

This method returns detailed information about the state of the fuel pump or charging station, connected to this Terminal.

Request for detailed information about state of fuel pump or charging station

URL:
- /term/fuel
Method: GET
URL parameters:
- none
Data parameters:
- none

Sample request:

  { 
      "method":"POST",
      "url":"https://api.incust.com/v1/term/fuel",
      "headers":{ 
          "Content-Type":"application/json",
          "Accept-Language":"en",
          "Authorization":"bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6ImRmNGYzNzJmLWM0NzktNDNkMi1iNDRhLTg3MDZiZWEyY2EwOSJ9.C5q8aw.KasPpXo01yFhoqei_M02VOLF6Fk"
      }
  }

Sample response:

  {
      "configuration": {
          "decimal_digits": {
              "amount": 2,
              "price": 2,
              "volume": 2
          }
      },
      "configuration_reading_status": "success",
      "configuration_updated": "2020-02-11T15:40:26.858000Z",
      "id": "e5177fc3-fc52-48df-a218-4414e67c48a5",
      "internal_id": "0034003A3435510938393730",
      "pumps": [
          {
              "available": true,
              "id": "4f54fe83-3c53-49b2-bf03-e7f37d342caa",
              "internal_id": "1",
              "jobs": {
                  "current": null,
                  "pending": [
                      {
                          "auto_capture_parent_transaction": false,
                          "created": "2020-02-10T16:53:51.504000Z",
                          "details": {
                              "fuel": {
                                  "controller": "0034003A3435510938393730",
                                  "controller_id": "e5177fc3-fc52-48df-a218-4414e67c48a5",
                                  "controller_type": "pts-2",
                                  "filled_amount": 0,
                                  "filled_volume": 0,
                                  "filling_doze": 30.0,
                                  "filling_price": 10.0,
                                  "filling_type": "amount",
                                  "goods_code": "Petrol 95",
                                  "nozzle": "4",
                                  "nozzle_id": "4f89b9d8-3455-4d05-abcc-2c177c6a180a",
                                  "pump": "1",
                                  "pump_id": "4f54fe83-3c53-49b2-bf03-e7f37d342caa",
                                  "status": "waiting-for-process"
                              },
                              "source_data": {
                                  "auto_start": true,
                                  "details": {
                                      "fuel": {
                                          "filling_doze": 30.0,
                                          "filling_price": 10.0,
                                          "filling_type": "amount",
                                          "nozzle_id": "4f89b9d8-3455-4d05-abcc-2c177c6a180a"
                                      }
                                  },
                                  "type": "fuel"
                              },
                              "start": {
                                  "command": "job_starting",
                                  "comment": "test",
                                  "processed": "2020-02-10 16:58:19"
                              }
                          },
                          "id": "26acb27d-f00b-495d-b8a4-658a96bc9248",
                          "status": "starting",
                          "type": "fuel"
                      }
                  ],
                  "recent": [
                      {
                          "auto_capture_parent_transaction": false,
                          "created": "2020-02-10T16:55:34.148000Z",
                          "details": {
                              "fuel": {
                                  "controller": "0034003A3435510938393730",
                                  "controller_id": "e5177fc3-fc52-48df-a218-4414e67c48a5",
                                  "controller_type": "pts-2",
                                  "filled_amount": 0,
                                  "filled_volume": 0,
                                  "filling_doze": 30.0,
                                  "filling_price": 10.0,
                                  "filling_type": "amount",
                                  "goods_code": "Petrol 95",
                                  "nozzle": "4",
                                  "nozzle_id": "4f89b9d8-3455-4d05-abcc-2c177c6a180a",
                                  "pump": "1",
                                  "pump_id": "4f54fe83-3c53-49b2-bf03-e7f37d342caa",
                                  "status": "waiting-for-process"
                              },
                              "source_data": {
                                  "auto_start": true,
                                  "details": {
                                      "fuel": {
                                          "filling_doze": 30.0,
                                          "filling_price": 10.0,
                                          "filling_type": "amount",
                                          "nozzle_id": "4f89b9d8-3455-4d05-abcc-2c177c6a180a"
                                      }
                                  },
                                  "type": "fuel"
                              },
                              "stop": {
                                  "command": "job_stopping",
                                  "comment": "test",
                                  "processed": "2020-02-10 16:56:03"
                              }
                          },
                          "id": "90840d95-1a60-4d6c-bd20-13bc84aa5b11",
                          "status": "finished",
                          "type": "fuel"
                      },
                      {
                          "auto_capture_parent_transaction": false,
                          "created": "2020-02-10T17:14:06.219000Z",
                          "details": {
                              "fuel": {
                                  "controller": "0034003A3435510938393730",
                                  "controller_id": "e5177fc3-fc52-48df-a218-4414e67c48a5",
                                  "controller_type": "pts-2",
                                  "filled_amount": 0,
                                  "filled_volume": 0,
                                  "filling_doze": 30.0,
                                  "filling_price": 10.0,
                                  "filling_type": "amount",
                                  "goods_code": "Petrol 95",
                                  "nozzle": "4",
                                  "nozzle_id": "4f89b9d8-3455-4d05-abcc-2c177c6a180a",
                                  "pump": "1",
                                  "pump_id": "4f54fe83-3c53-49b2-bf03-e7f37d342caa",
                                  "status": "waiting-for-process"
                              },
                              "source_data": {
                                  "auto_start": true,
                                  "details": {
                                      "fuel": {
                                          "filling_doze": 30.0,
                                          "filling_price": 10.0,
                                          "filling_type": "amount",
                                          "nozzle_id": "4f89b9d8-3455-4d05-abcc-2c177c6a180a"
                                      }
                                  },
                                  "type": "fuel"
                              },
                              "stop": {
                                  "command": "job_stopping",
                                  "comment": "test",
                                  "processed": "2020-02-10 17:14:28"
                              }
                          },
                          "finished": "2020-02-10T17:14:28.491000Z",
                          "id": "e6631ea7-4e1f-4694-8ac5-914d5df07a4b",
                          "status": "finished",
                          "type": "fuel"
                      }
                  ]
              },
              "nozzles": [
                  {
                      "code": "Petrol 92",
                      "goods": {
                          "active": 1,
                          "code": "Petrol 92",
                          "color": 4294967295,
                          "id": "8d4f580f-28c8-4966-933e-d3929a95f3a2",
                          "loyalty_id": "b4e262e7-0d35-11e6-bfd1-020000ed147d",
                          "price": [
                              {
                                  "currency": "USD",
                                  "id": "dbe00788-24d3-4655-a1d1-3396e718bc6b",
                                  "price": 20.0,
                                  "type": "currency"
                              }
                          ],
                          "service_types": [
                              "fuel"
                          ],
                          "sort_order": 0,
                          "title": "A92 petrol",
                          "variable_price": 0,
                          "variable_total": 0,
                          "weighing": 0,
                          "whole_number": 1
                      },
                      "id": "ae456b8e-28f9-43c5-8bf8-2f03b512e6a9",
                      "internal_id": "1"
                  }
              ],
              "status": "idle",
              "status_description": "Pump is in idle state",
              "terminal_id": "b4e361ee-0d35-11e6-bfd1-020000ed147d"
          },
          {
              "available": true,
              "id": "a8e76661-e678-4ca5-9257-cf4c5ff28130",
              "internal_id": "3",
              "jobs": {
                  "current": null,
                  "pending": [],
                  "recent": []
              },
              "nozzles": [
                  {
                      "code": "Petrol 92",
                      "goods": {
                          "active": 1,
                          "code": "Petrol 92",
                          "color": 4294967295,
                          "id": "8d4f580f-28c8-4966-933e-d3929a95f3a2",
                          "loyalty_id": "b4e262e7-0d35-11e6-bfd1-020000ed147d",
                          "price": [
                              {
                                  "currency": "USD",
                                  "id": "dbe00788-24d3-4655-a1d1-3396e718bc6b",
                                  "price": 20.0,
                                  "type": "currency"
                              }
                          ],
                          "service_types": [
                              "fuel"
                          ],
                          "sort_order": 0,
                          "title": "A92 petrol",
                          "variable_price": 0,
                          "variable_total": 0,
                          "weighing": 0,
                          "whole_number": 1
                      },
                      "id": "09482f0e-003a-408d-b56c-f6ee4f5f80b6",
                      "internal_id": "1"
                  }
              ],
              "status": "idle",
              "status_description": "Pump is in idle state",
              "terminal_id": "b4e361ee-0d35-11e6-bfd1-020000ed147d"
          }
      ],
      "skip_pumps_in_selection": 0
  }

Remarks:
The response will contain the object that includes complex information about the state of the fuel pumps or charging stations :
- id: unique Id of the controller
- internal_id: internal identifier of the controller device
- configuration: an object with controller configuration:
  - decimal_digits: setup of decimal digits:
    - amount: the number of decimal digits in the sum values
    - price: the number of decimal digits in the price
    - volume: the number of decimal digits in the volume
- configuration_reading_status: the status of the last attempt of reading the controller configuration:
  - connection-not-configured - communication settings of the controller not set
  - ready-to-read - communication settings of the controller are set, configuration not retrieved yet
  - success - communication established, configuration retrieved
  - fail - error in communication with the controller
- configuration_updated: Date and time of the last reading of configuration in YYYY-MM-DD[T]HH:mm:ss[Z] format, UTC time zone
- skip_pumps_in_selection: the flag that specifies the kind of selection of the fueling or charging point:
  - 0 - first the pump or charging station, then the hose or connector is selected
  - 1 - the hose or connector is selected without choosing the pump or charging station (all available hoses or connectors of all pumps or charging stations is provided in the list)
- pumps: the list of objects with information about the pumps or charging stations:
  - id: unique Id of the pump or charging station
  - internal_id: the number of the pump or charging station
  - terminal_id: unique Id of the Terminal, connected to the pump or charging station
  - available: the indicator of availability of the pump or charging station for the fuel or energy delivery operation (turned on, connected and not busy with another operation)
  - status: the state of the pump or charging station:
    - idle - the pump or charging station is in the Idle/Waiting state
    - filling - the pump or charging station is delivering fuel or energy
    - end-of-transaction - the pump or charging station has finished delivery of fuel or energy
    - offline - the pump or charging station is not connected or does not respond
  - status_description: description of the state of the pump or charging station
  - nozzles: the list of the hoses or connectors that belong to this pump or charging station
    - id: unique Id of the hose or connector
    - internal_id: the number of the hose or connector
    - up: the flag that indicates that the hose or connector has been picked from the pump or charging station
    - code: code of the fuel or energy, delivered from this hose or connector
    - goods: the object of goods that corresponds to the code of the fuel or energy, delivered from this hose or connector
  - jobs: the list of jobs, related to this pump or charging station
    - current: current job, being processed by the pump or charging station now
    - recent: the list of jobs, already processed by the pump or charging station (the last 10 jobs)
    - pending: the list of jobs, waiting for their turn to be processed by the pump or charging station

Goods and categories in brand

Using Terminal API, you can create and update goods and categories within the brand.

Retrieve goods list

URL: /term/loyalty/goods
Method: GET
URL parameters:
- only_active
  - 'true' – return only active goods
  - 'false' – return all goods (default)
Data parameters:
- none

Sample request:

{
   "method":"GET",
   "url":"https://api.incust.com/v1/term/loyalty/goods",
   "headers":{
      "Content-Type":"application/json",
      "Accept-Language":"en",
      "Authorization":"bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6ImRmNGYzNzJmLWM0NzktNDNkMi1iNDRhLTg3MDZiZWEyY2EwOSJ9.C5g1YA.q6yWPEECM12jhAzphz2BOWNO8mg"
   }
}

Sample response:

[
   {
      "active":1,
      "code":"1444",
      "color":4294967295,
      "id":"1bd042be-2458-4612-9fca-f47ae7086fb6",
      "image":{
         "id":"5130ac00-f142-4ec1-a320-8bcaa1ff6ea8",
         "url":"https://api.incust.com/static/46/24/e3f3046640f79506021683de9a8a.jpeg"
      },
      "image_id":"5130ac00-f142-4ec1-a320-8bcaa1ff6ea8",
      "loyalty_id":"87f74cd0-b174-11e6-bfd1-020000ed147d",
      "parent_code":"Drinks",
      "parent_id":"3dfc0bd1-7052-4748-98f1-2f747f70a500",
      "parent_title":"Drinks",
      "price":[
         {
            "id":"86d70a06-7fb9-4ef5-b79d-a36a198ab9c9",
            "price":1,
            "special_account":{
               "active":1,
               "goods_items":[
                  "1444"
               ],
               "id":"23116258-bffd-4b8c-9c42-a3d8c4a941bd",
               "public_title":"Prepayment for coffee",
               "title":"Prepayment for coffee",
               "type":"goods",
               "unconfirmed_redeem_amount":0
            },
            "special_account_id":"23116258-bffd-4b8c-9c42-a3d8c4a941bd",
            "type":"special-account"
         },
         {
            "id":"98b78cdc-34a7-452a-8624-6f3bd069770c",
            "price":7,
            "special_account":{
               "active":1,
               "id":"c785aa00-d288-4384-814e-f33fc074c7b2",
               "public_title":"Visit reward",
               "title":"Visit reward",
               "type":"punches",
               "unconfirmed_redeem_amount":0
            },
            "special_account_id":"c785aa00-d288-4384-814e-f33fc074c7b2",
            "type":"special-account"
         },
         {
            "currency":"USD",
            "id":"154264aa-05ad-4d1d-8858-7101ddde451e",
            "price":1,
            "type":"currency"
         }
      ],
      "sort_order":0,
      "title":"Coffee",
      "unit":"pcs",
      "variable_price":0,
      "variable_total":0,
      "weighing":0,
      "whole_number":1
   },
   {
      "active":1,
      "code":"11111",
      "color":4294967295,
      "id":"4ce153e5-8ed9-4840-bcd3-e0f77536e055",
      "image":{
         "id":"9d377a96-ee6e-4322-88a2-c56563131537",
         "url":"https://api.incust.com/static/b0/67/d83f371e4bc998896556f16970e7.jpeg"
      },
      "image_id":"9d377a96-ee6e-4322-88a2-c56563131537",
      "loyalty_id":"87f74cd0-b174-11e6-bfd1-020000ed147d",
      "parent_code":"Pizza",
      "parent_id":"a85f4142-2fe3-4806-9843-5229d4bcf938",
      "parent_title":"Pizza",
      "price":[
         {
            "id":"ec708edb-c334-43c1-b322-9f267c14748d",
            "price":20,
            "special_account":{
               "active":1,
               "id":"c785aa00-d288-4384-814e-f33fc074c7b2",
               "public_title":"Visit reward",
               "title":"Visit reward",
               "type":"punches",
               "unconfirmed_redeem_amount":0
            },
            "special_account_id":"c785aa00-d288-4384-814e-f33fc074c7b2",
            "type":"special-account"
         },
         {
            "currency":"USD",
            "id":"375f47d9-8338-4861-a7d1-d690d6c77203",
            "price":8,
            "type":"currency"
         }
      ],
      "sort_order":0,
      "title":"Pizza 5 cheese",
      "unit":"pcs",
      "variable_price":0,
      "variable_total":0,
      "weighing":0,
      "whole_number":1
   },
   {
      "active":1,
      "code":"12344",
      "color":4294967295,
      "id":"5b6a423d-9a05-470c-a0c4-aaa0400433a8",
      "image":{
         "id":"ebced7ef-8b31-4aa9-859d-1492eef0db4c",
         "url":"https://api.incust.com/static/59/15/ec56e3964316a57ef51f90690cd1.jpeg"
      },
      "image_id":"ebced7ef-8b31-4aa9-859d-1492eef0db4c",
      "loyalty_id":"87f74cd0-b174-11e6-bfd1-020000ed147d",
      "parent_code":"Pizza",
      "parent_id":"a85f4142-2fe3-4806-9843-5229d4bcf938",
      "parent_title":"Pizza",
      "price":[
         {
            "id":"21185186-db47-409c-954c-24e1f1119152",
            "price":40,
            "special_account":{
               "active":1,
               "id":"c785aa00-d288-4384-814e-f33fc074c7b2",
               "public_title":"Visit reward",
               "title":"Visit reward",
               "type":"punches",
               "unconfirmed_redeem_amount":0
            },
            "special_account_id":"c785aa00-d288-4384-814e-f33fc074c7b2",
            "type":"special-account"
         },
         {
            "currency":"USD",
            "id":"e25d31df-9f2c-4a05-a7c6-637acc27e1af",
            "price":9.50,
            "type":"currency"
         }
      ],
      "sort_order":0,
      "title":"Meat pizza",
      "unit":"pcs",
      "variable_price":0,
      "variable_total":0,
      "weighing":0,
      "whole_number":1
   },
   {
      "active":1,
      "code":"54321",
      "color":4294967295,
      "id":"880abda0-04c2-4779-a93d-92d5273ec5eb",
      "image":{
         "id":"9f0b02a7-fe61-420b-9ec5-016ccb66a0d8",
         "url":"https://api.incust.com/static/50/76/5c1b743f450aa3c4be7c7ab887d9.jpeg"
      },
      "image_id":"9f0b02a7-fe61-420b-9ec5-016ccb66a0d8",
      "loyalty_id":"87f74cd0-b174-11e6-bfd1-020000ed147d",
      "parent_code":"Drinks",
      "parent_id":"3dfc0bd1-7052-4748-98f1-2f747f70a500",
      "parent_title":"Drinks",
      "price":[
         {
            "id":"4c608c24-2a6b-4664-b409-b51ff4ffb170",
            "price":5,
            "special_account":{
               "active":1,
               "id":"c785aa00-d288-4384-814e-f33fc074c7b2",
               "public_title":"Visit reward",
               "title":"Visit reward",
               "type":"punches",
               "unconfirmed_redeem_amount":0
            },
            "special_account_id":"c785aa00-d288-4384-814e-f33fc074c7b2",
            "type":"special-account"
         },
         {
            "currency":"USD",
            "id":"fe535973-5236-4b7f-a515-747a4741030d",
            "price":25,
            "type":"currency"
         }
      ],
      "sort_order":0,
      "title":"Ginger tea",
      "unit":"pcs",
      "variable_price":0,
      "variable_total":0,
      "weighing":0,
      "whole_number":1
   },
   {
      "active":1,
      "code":"3113",
      "color":4294967295,
      "id":"fbed57fb-207e-4b55-8da7-dae8e1896d84",
      "image":{
         "id":"90942b1b-295c-45c0-b081-49d67e0b70bc",
         "url":"https://api.incust.com/static/04/1b/e6235b1c420e950bd50908d8c844.jpeg"
      },
      "image_id":"90942b1b-295c-45c0-b081-49d67e0b70bc",
      "loyalty_id":"87f74cd0-b174-11e6-bfd1-020000ed147d",
      "parent_code":"Desserts",
      "parent_id":"e609f66f-9bd2-4352-8b71-bd3228774ff2",
      "parent_title":"Desserts",
      "price":[
         {
            "id":"71f4f14e-7038-4895-823b-5b22166620a9",
            "price":15,
            "special_account":{
               "active":1,
               "id":"c785aa00-d288-4384-814e-f33fc074c7b2",
               "public_title":"Visit reward",
               "title":"Visit reward",
               "type":"punches",
               "unconfirmed_redeem_amount":0
            },
            "special_account_id":"c785aa00-d288-4384-814e-f33fc074c7b2",
            "type":"special-account"
         },
         {
            "currency":"USD",
            "id":"b20975ab-ecda-4ee0-88f0-b6dbca51e1aa",
            "price":50,
            "type":"currency"
         }
      ],
      "sort_order":0,
      "title":"Blueberry dessert",
      "unit":"pcs",
      "variable_price":0,
      "variable_total":0,
      "weighing":0,
      "whole_number":1
   }
]

Remarks:
In the case of a well-formed request and correct data, the response will contain an array of goods, with which Terminal operates. Each array element is an object that contains the following fields:
- id: goods ID
- code: goods code
- active: goods is active an can be purchased (1 – yes, 0 – no)
- color: goods color (integer)
- title: goods name
- image:
  - id: picture ID
  - url: link to picture
- additional_images:
  - id: ID of supplementary picture
  - url: link to supplementary picture
- parent_id: parent category ID
- parent_code: parent category code
- parent_title: parent category name
- price: array of goods prices may contain objects of two types:
  - goods price expressed in currency, contains the following fields:
    - id: price ID
    - type: currency type set to currency
    - currency: currency, in which the price is expressed
    - price: goods price (integer)
  - goods price for customer account
    - id: price ID
    - type: currency type set to special-account
    - price: goods price (integer)
    - special_account_id: customer account ID
    - special_account: an object that contains information about the customer account
      - active: activity flag (1 - yes, 0 - no)
      - id: account ID
      - public_title: localized account name
      - title: account name
      - type: account type. Possible values are 'punches', 'goods', 'money'
      - unconfirmed_redeem_amount: number of goods items that can be written off from the account without a confirmation via SMS
      - goods_items: array of codes of goods linked to the account; is present in response
        only if type is 'goods'
- sort_order: goods sorting order
- unit: units of measurement of goods ('kilograms', 'ounces', 'liters', etc.)
- variable_price: goods price may be modified (1 – yes, 0 – no), specifies that the cashier can enter the goods price
  instead of the one specified in the Control Panel
- variable_total: final goods price (total) may be modified (1 – yes, 0 – no)
- weighing: weighted goods (1 – yes, 0 – no)
- whole_number: goods can be sold only in integral units (1 – yes, 0 – no)

Create goods

URL: /term/loyalty/goods
Method: POST
URL parameters:
- none
Data parameters:
- code: goods code
- active: goods is active an can be purchased (1 – yes, 0 – no)
- color: goods color (integer)
- title: goods name
- parent_id: parent category ID
- sort_order: goods sorting order
- unit, units of measurement of goods ('kilograms', 'ounces', 'liters' etc.)
- variable_price: goods price may be modified (1 – yes, 0 – no), specifies that the cashier can enter the goods price
  instead of the one specified in the Control Panel
- variable_total: final goods price (total) may be modified (1 – yes, 0 – no)
- weighing: weighted goods (1 – yes, 0 – no)

Sample request:

{
     "method":"POST",
     "url":"https://api.incust.com/v1/term/goods",
     "headers":{
        "Content-Type":"application/json",
        "Accept-Language":"en",
        "Authorization":"bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6IjAyYmE2YmVhLWVjZjMtMTFlNS1hODNhLTAyMDAwMGVkMTQ3ZCJ9.C7_mAg.KT2RcE4BwIFr8GXvTzVrzKXaODQ"
     },
     "data":{
        "parent_id":"4729488e-051a-4238-bebb-9d40306109b3",
        "title":"Coffee",
        "code":"1444",
        "active":1,
        "color":785150463,
        "unit":"pcs",
        "variable_price":0,
        "variable_total":0,
        "weighing":0,
        "whole_number":1
     }
}

Sample response:

  [
     {
        "active":1,
        "code":"1444",
        "color":785150463,
        "id":"1bd042be-2458-4612-9fca-f47ae7086fb6",
        "loyalty_id":"87f74cd0-b174-11e6-bfd1-020000ed147d",
        "parent_code":"Drinks",
        "parent_id":"4729488e-051a-4238-bebb-9d40306109b3",
        "parent_title":"Drinks",
        "sort_order":0,
        "title":"Coffee",
        "unit":"pcs",
        "variable_price":0,
        "variable_total":0,
        "weighing":0,
        "whole_number":1
     }
  ]

Remarks:
In the case of a well-formed request and correct data, the response will contain the data of the goods.

URL: /term/loyalty//goods/categories
Method: GET
URL parameters:
- only_active
  - 'true' – return only active categories
  - 'false' – return all categories (default)
Data parameters:
- none

Sample request:

 { 
   "method":"GET",
   "url":"https://api.incust.com/v1/term/loyalty/goods/categories",
   "headers":{ 
      "Content-Type":"application/json",
      "Accept-Language":"en",
      "Authorization":"bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6IjAyYmE2YmVhLWVjZjMtMTFlNS1hODNhLTAyMDAwMGVkMTQ3ZCJ9.C5gyNg.HwPVfsPdcDR1GX3kHnQ6e1EcnpQ"
   }
 }

Sample response:

 [ 
   { 
      "active":1,
      "code":"Goods category 1",
      "color":3545497855,
      "id":"38aa3c1c-21c5-4bf8-a25f-4df4043bfb3a",
      "title":"Product category 1",
      "image":{ 
         "id":"d47ee357-af5c-49d7-adad-e4e76649d2eb",
         "url":"https://api.incust.com/static/d7/85/cc792b8e4d4ca24de7ea53b5b745.jpeg"
      },
      "nodes":[ 
         { 
            "active":1,
            "code":"Goods subcategory 1.1",
            "color":4294967295,
            "id":"acb18938-0393-4a95-9efd-8b61f0f1058d",
            "parent_id":"38aa3c1c-21c5-4bf8-a25f-4df4043bfb3a",
            "title":"Goods subcategory 1.1"
         }
      ]
   },
   { 
      "active":1,
      "code":"Goods category 2",
      "color":4294967295,
      "id":"4729488e-051a-4238-bebb-9d40306109b3",
      "title":"Goods category 2"
   },
   { 
      "active":1,
      "code":"Goods category 3",
      "color":4294967295,
      "id":"82daa2d8-774a-44df-a078-b26d41ed4290",
      "title":"Goods category 3"
   }
 ]

Remarks:
In the case of a well-formed request and correct data, the response will contain an array of categories, with which Terminal operates. Each array element is an object that contains the following fields:
- id: category ID
- active: category is active (1 – yes, 0 – no)
- code: category code
- color: category color (integer)
- title: category name
- image:
  - id: picture ID
  - url: link to picture
- nodes: array of child categories. The structure of the array is identical to the one described above, and each child category may contain own "nodes" array, thus forming a hierarchy.

Create goods category

URL: /term/loyalty/goods/categories
Method: POST
URL parameters:
- none
Data parameters:
- active: category is active (1 – yes, 0 – no)
- code: category code
- color: category color (integer)
- title: category name
- parent_id: parent category ID

Sample request:

 {
    "method": "POST",
    "url": "https://api.incust.com/v1/term/loyalty/goods/category",
    "headers": {
      "Content-Type": "application/json",
      "Accept-Language": "en",
      "Authorization": "bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6IjAyYmE2YmVhLWVjZjMtMTFlNS1hODNhLTAyMDAwMGVkMTQ3ZCJ9.C7_mAg.KT2RcE4BwIFr8GXvTzVrzKXaODQ"
    },
    "data": {
      "parent_id": "4729488e-051a-4238-bebb-9d40306109b3",
      "title": "Goods category 1",
      "active": 1,
      "color": 785150463
    }
 }

Sample response:

 {
  "active": 1,
  "color": 785150463,
  "id": "82daa2d8-774a-44df-a078-b26d41ed4290",
  "image": {
    "id": "6df52c1d-28d5-410c-9e35-a476452544a8",
    "url": "https://incust.com/v1/storage/asset/image/6df52c1d-28d5-410c-9e35-a476452544a8?1603782421"
  },
  "image_id": "6df52c1d-28d5-410c-9e35-a476452544a8",
  "loyalty_id": "3ac1a51f-3410-11e8-8196-020000ed147d",
  "title": "Goods category 1"
 }

Remarks:
In the case of a well-formed request and correct data, the response will contain an array of categories, with which Terminal operates. Each array element is an object that contains the following fields:
- id: сategory ID
- active: category is active (1 – yes, 0 – no)
- code: category code
- color: category color (integer)
- title: category name
- image:
  - id: picture ID
  - url: link to picture
- nodes: array of child categories. The structure of the array is identical to the one described above, and each child category may contain own "nodes" array, thus forming a hierarchy.

Obtain information about goods category

URL: /term/loyalty/goods/category/{id}
Method: GET
URL parameters:
- id: сategory ID
Data parameters:
- none

Sample request:

 { 
   "method":"GET",
   "url":"https://api.incust.com/v1/term/loyalty/goods/category/38aa3c1c-21c5-4bf8-a25f-4df4043bfb3a",
   "headers":{ 
      "Content-Type":"application/json",
      "Accept-Language":"en",
      "Authorization":"bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6IjAyYmE2YmVhLWVjZjMtMTFlNS1hODNhLTAyMDAwMGVkMTQ3ZCJ9.C5gyNg.HwPVfsPdcDR1GX3kHnQ6e1EcnpQ"
   }
}

Sample response:

 [ 
   { 
      "active":1,
      "code":"Goods category 1",
      "color":3545497855,
      "id":"38aa3c1c-21c5-4bf8-a25f-4df4043bfb3a",
      "title":"Goods category 1",
      "image":{ 
         "id":"d47ee357-af5c-49d7-adad-e4e76649d2eb",
         "url":"https://api.incust.com/static/d7/85/cc792b8e4d4ca24de7ea53b5b745.jpeg"
      },
      "nodes":[ 
         { 
            "active":1,
            "code":"Goods subcategory 1.1",
            "color":4294967295,
            "id":"acb18938-0393-4a95-9efd-8b61f0f1058d",
            "parent_id":"38aa3c1c-21c5-4bf8-a25f-4df4043bfb3a",
            "title":"Goods subcategory 1.1"
         }
      ]
   }
 ]

Remarks:
In the case of a well-formed request and correct data, the response will contain an object that contains the following fields:
- id: сategory ID
- active: category is active (1 – yes, 0 – no)
- code: category code
- color: category color (integer)
- title: category name
- image:
  - id: picture ID
  - url: link to picture
- nodes: array of child categories. The structure of the array is identical to the one described above, and each child category may contain own "nodes" array, thus forming a hierarchy.

Change goods category

URL: /term/loyalty/goods/category/{id}
Method: PATCH
URL parameters:
- id: сategory ID
Data parameters:
- active: category is active (1 – yes, 0 – no)
- code: category code
- color: category color (integer)
- title: category name
- parent_id: parent category ID

Sample request:

 {
    "method": "PATCH",
    "url": "https://api.incust.com/v1/term/loyalty/goods/category/82daa2d8-774a-44df-a078-b26d41ed4290",
    "headers": {
      "Content-Type": "application/json",
      "Accept-Language": "en",
      "Authorization": "bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6IjAyYmE2YmVhLWVjZjMtMTFlNS1hODNhLTAyMDAwMGVkMTQ3ZCJ9.C7_mAg.KT2RcE4BwIFr8GXvTzVrzKXaODQ"
    },
    "data": {
      "parent_id": "4729488e-051a-4238-bebb-9d40306109b3",
      "title": "Goods category 1",
      "active": 1,
      "color": 785150463
    }
 }

Sample response:

{
  "active": 1,
  "color": 785150463,
  "id": "82daa2d8-774a-44df-a078-b26d41ed4290",
  "image": {
    "id": "6df52c1d-28d5-410c-9e35-a476452544a8",
    "url": "https://incust.com/v1/storage/asset/image/6df52c1d-28d5-410c-9e35-a476452544a8?1603782421"
  },
  "image_id": "6df52c1d-28d5-410c-9e35-a476452544a8",
  "loyalty_id": "3ac1a51f-3410-11e8-8196-020000ed147d",
  "title": "Goods category 1"
}

Remarks:
In the case of a well-formed request and correct data, the response will contain an object that contains the following fields:
- id: сategory ID
- active: category is active (1 – yes, 0 – no)
- code: category Code
- color: category color (integer)
- title: category name
- image:
  - id: picture ID
  - url: link to picture
- nodes: array of child categories. The structure of the array is identical to the one described above, and each child category may contain own "nodes" array, thus forming a hierarchy.

Add or change goods category image

URL: /term/loyalty/goods/category/{id}/photo
Method: POST
URL parameters:
- id: сategory ID
Data parameters:
- picture as binary

Sample request:

 {
    "method": "PATCH",
    "url": "https://api.incust.com/v1/term/loyalty/goods/category/82daa2d8-774a-44df-a078-b26d41ed4290",
    "headers": {
      "Content-Type": "image/jpeg",
      "Accept-Language": "en",
      "Authorization": "bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6IjAyYmE2YmVhLWVjZjMtMTFlNS1hODNhLTAyMDAwMGVkMTQ3ZCJ9.C7_mAg.KT2RcE4BwIFr8GXvTzVrzKXaODQ"
    },

    "data": "picture as binary"
 }

Sample response:

 {
  "active": 1,
  "color": 785150463,
  "id": "82daa2d8-774a-44df-a078-b26d41ed4290",
  "image": {
    "id": "6df52c1d-28d5-410c-9e35-a476452544a8",
    "url": "https://incust.com/v1/storage/asset/image/6df52c1d-28d5-410c-9e35-a476452544a8?1603782421"
  },
  "image_id": "6df52c1d-28d5-410c-9e35-a476452544a8",
  "loyalty_id": "3ac1a51f-3410-11e8-8196-020000ed147d",
  "title": "Goods category 1"
 }

Remarks:
The acceptable Content-Type in the header are image/jpeg or image/png
In the case of a well-formed request and correct data, the response will contain an object that contains the following fields:
- id: сategory ID
- active: category is active (1 – yes, 0 – no)
- code: category code
- color: category color (integer)
- title: category name
- image:
  - id: picture ID
  - url: link to picture
- nodes: array of child categories. The structure of the array is identical to the one described above, and each child category may contain own "nodes" array, thus forming a hierarchy.

Retrieve goods by code

URL: /term/loyalty/goods/code
Method: POST
URL parameters:
- none
Data parameters:
- code: goods code

Sample request:

  {
    "method": "POST",
    "url": "https://api.incust.com/v1/term/loyalty/goods/code",
    "headers": {
      "Content-Type": "application/json",
      "Accept-Language": "en",
      "Authorization": "bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6IjAyYmE2YmVhLWVjZjMtMTFlNS1hODNhLTAyMDAwMGVkMTQ3ZCJ9.C7_mAg.KT2RcE4BwIFr8GXvTzVrzKXaODQ"
    },
    "data": {
      "code": "1444"
    }
  }

Sample response:

  [
   {
      "active":1,
      "code":"1444",
      "color":4294967295,
      "id":"1bd042be-2458-4612-9fca-f47ae7086fb6",
      "image":{
         "id":"5130ac00-f142-4ec1-a320-8bcaa1ff6ea8",
         "url":"https://api.incust.com/static/46/24/e3f3046640f79506021683de9a8a.jpeg"
      },
      "image_id":"5130ac00-f142-4ec1-a320-8bcaa1ff6ea8",
      "loyalty_id":"87f74cd0-b174-11e6-bfd1-020000ed147d",
      "parent_code":"Drinks",
      "parent_id":"3dfc0bd1-7052-4748-98f1-2f747f70a500",
      "parent_title":"Drinks",
      "price":[
         {
            "id":"86d70a06-7fb9-4ef5-b79d-a36a198ab9c9",
            "price":1,
            "special_account":{
               "active":1,
               "goods_items":[
                  "1444"
               ],
               "id":"23116258-bffd-4b8c-9c42-a3d8c4a941bd",
               "public_title":"Prepayment for coffee",
               "title":"Prepayment for coffee",
               "type":"goods",
               "unconfirmed_redeem_amount":0
            },
            "special_account_id":"23116258-bffd-4b8c-9c42-a3d8c4a941bd",
            "type":"special-account"
         },
         {
            "id":"98b78cdc-34a7-452a-8624-6f3bd069770c",
            "price":7,
            "special_account":{
               "active":1,
               "id":"c785aa00-d288-4384-814e-f33fc074c7b2",
               "public_title":"Visit reward",
               "title":"Visit reward",
               "type":"punches",
               "unconfirmed_redeem_amount":0
            },
            "special_account_id":"c785aa00-d288-4384-814e-f33fc074c7b2",
            "type":"special-account"
         },
         {
            "currency":"USD",
            "id":"154264aa-05ad-4d1d-8858-7101ddde451e",
            "price":1,
            "type":"currency"
         }
      ],
      "sort_order":0,
      "title":"Coffee",
      "unit":"pcs",
      "variable_price":0,
      "variable_total":0,
      "weighing":0,
      "whole_number":1
   }
  ]

Remarks:
In the case of a well-formed request and correct data, the response will contain the data of the goods with the following fields:
- id: goods ID
- code: goods code
- active: activity flag (1 – yes, 0 – no)
- color: goods color (integer)
- title: goods name
- image:
  - id: picture ID
  - url: link to picture
- additional_images:
  - id: ID of supplementary picture
  - url: link to supplementary picture
- parent_id: parent category ID
- parent_code: code of the parent category
- parent_title: name of the parent category
- price: array of goods prices may contain objects of two types:
  - goods price expressed in currency, contains the following fields:
    - id: price ID
    - type: currency type set to currency
    - currency: currency, in which the price is expressed
    - price: goods price (integer)
  - goods price for customer account
    - id: price ID
    - type: currency type set to special-account
    - price: goods price (integer)
    - special_account_id: customer account ID
    - special_account: an object that contains information about the customer account
      - active: activity flag (1 - yes, 0 - no)
      - id: account ID
      - public_title: localized account name
      - title: account name
      - type: account type. Possible values are 'punches', 'goods', 'money'
      - unconfirmed_redeem_amount: number of goods items that can be written off from the account without a confirmation via SMS
      - goods_items: array of codes of goods linked to the account; is present in response
        only if type is 'goods'
- sort_order: goods sorting order
- unit: units of measurement of goods ('kilograms', 'ounces', 'liters', etc.)
- variable_price: goods price may be modified (1 – yes, 0 – no), specifies that the cashier can enter the goods price
  instead of the one specified in the Control Panel
- variable_total: final goods price (total) may be modified (1 – yes, 0 – no)
- weighing: weighted goods (1 – yes, 0 – no)
- whole_number: goods can be sold only in integral units (1 – yes, 0 – no)

Retrieve goods by ID

URL: /term/loyalty/goods/{id}
Method: GET
URL parameters:
- id: goods ID
Data parameters:
- none

Sample request:

 {
    "method": "GET",
    "url": "https://api.incust.com/v1/term/loyalty/goods/1bd042be-2458-4612-9fca-f47ae7086fb6",
    "headers": {
      "Content-Type": "application/json",
      "Accept-Language": "en",
      "Authorization": "bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6IjAyYmE2YmVhLWVjZjMtMTFlNS1hODNhLTAyMDAwMGVkMTQ3ZCJ9.C7_mAg.KT2RcE4BwIFr8GXvTzVrzKXaODQ"
    }
 }

Sample response:

    {
      "active":1,
      "code":"1444",
      "color":4294967295,
      "id":"1bd042be-2458-4612-9fca-f47ae7086fb6",
      "image":{
         "id":"5130ac00-f142-4ec1-a320-8bcaa1ff6ea8",
         "url":"https://api.incust.com/static/46/24/e3f3046640f79506021683de9a8a.jpeg"
      },
      "image_id":"5130ac00-f142-4ec1-a320-8bcaa1ff6ea8",
      "loyalty_id":"87f74cd0-b174-11e6-bfd1-020000ed147d",
      "parent_code":"Drinks",
      "parent_id":"3dfc0bd1-7052-4748-98f1-2f747f70a500",
      "parent_title":"Drinks",
      "price":[
         {
            "id":"86d70a06-7fb9-4ef5-b79d-a36a198ab9c9",
            "price":1,
            "special_account":{
               "active":1,
               "goods_items":[
                  "1444"
               ],
               "id":"23116258-bffd-4b8c-9c42-a3d8c4a941bd",
               "public_title":"Prepayment for coffee",
               "title":"Prepayment for coffee",
               "type":"goods",
               "unconfirmed_redeem_amount":0
            },
            "special_account_id":"23116258-bffd-4b8c-9c42-a3d8c4a941bd",
            "type":"special-account"
         },
         {
            "id":"98b78cdc-34a7-452a-8624-6f3bd069770c",
            "price":7,
            "special_account":{
               "active":1,
               "id":"c785aa00-d288-4384-814e-f33fc074c7b2",
               "public_title":"Visit reward",
               "title":"Visit reward",
               "type":"punches",
               "unconfirmed_redeem_amount":0
            },
            "special_account_id":"c785aa00-d288-4384-814e-f33fc074c7b2",
            "type":"special-account"
         },
         {
            "currency":"USD",
            "id":"154264aa-05ad-4d1d-8858-7101ddde451e",
            "price":1,
            "type":"currency"
         }
      ],
      "sort_order":0,
      "title":"Coffee",
      "unit":"pcs",
      "variable_price":0,
      "variable_total":0,
      "weighing":0,
      "whole_number":1
    }

Remarks:
In the case of a well-formed request and correct data, the response will contain the data of the goods with the following fields:
- id: goods ID
- code: goods code
- active: activity flag (1 – yes, 0 – no)
- color: goods color (integer)
- title: goods name
- image:
  - id: picture ID
  - url: link to picture
- additional_images:
  - id: ID of supplementary picture
  - url: link to supplementary picture
- parent_id: parent category ID
- parent_code: code of the parent category
- parent_title: name of the parent category
- price: array of goods prices may contain objects of two types:
  - goods price expressed in currency, contains the following fields:
    - id: price ID
    - type: currency type set to currency
    - currency: currency, in which the price is expressed
    - price: goods price (integer)
  - goods price for customer account
    - id: price ID
    - type: currency type set to special-account
    - price: goods price (integer)
    - special_account_id: customer account ID
    - special_account: an object that contains information about the customer account
      - active: activity flag (1 - yes, 0 - no)
      - id: account ID
      - public_title: localized account name
      - title: account name
      - type: account type. Possible values are 'punches', 'goods', 'money'
      - unconfirmed_redeem_amount: number of goods items that can be written off from the account without a confirmation via SMS
      - goods_items: array of codes of goods linked to the account; is present in response
        only if type is 'goods'
- sort_order: goods sorting order
- unit: units of measurement of goods ('kilograms', 'ounces', 'liters', etc.)
- variable_price: goods price may be modified (1 – yes, 0 – no), specifies that the cashier can enter the goods price
  instead of the one specified in the Control Panel
- variable_total: final goods price (total) may be modified (1 – yes, 0 – no)
- weighing: weighted goods (1 – yes, 0 – no)
- whole_number: goods can be sold only in integral units (1 – yes, 0 – no)

Change goods

URL: /term/loyalty/goods/{id}
Method: PATCH
URL parameters:
- id: goods ID
Data parameters:
- code: goods code
- active: activity flag (1 – yes, 0 – no)
- color: goods color (integer)
- title: goods name
- parent_id: parent category ID
- sort_order: goods sorting order
- unit: units of measurement of goods ('kilograms', 'ounces', 'liters', etc.)
- variable_price: goods price may be modified (1 – yes, 0 – no), specifies that the cashier can enter the goods price
  instead of the one specified in the Control Panel
- variable_total: final goods price (total) may be modified (1 – yes, 0 – no)
- weighing: weighted goods (1 – yes, 0 – no)
- whole_number: goods can be sold only in integral units (1 – yes, 0 – no)

Sample request:

 {
    "method": "PATCH",
    "url": "https://api.incust.com/v1/term/loyalty/goods/5130ac00-f142-4ec1-a320-8bcaa1ff6ea8",
    "headers": {
      "Content-Type": "application/json",
      "Accept-Language": "en",
      "Authorization": "bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6IjAyYmE2YmVhLWVjZjMtMTFlNS1hODNhLTAyMDAwMGVkMTQ3ZCJ9.C7_mAg.KT2RcE4BwIFr8GXvTzVrzKXaODQ"
    },
    "data": {
      "parent_id": "3dfc0bd1-7052-4748-98f1-2f747f70a500",
      "title": "Coffee",
      "active": 1,
      "color": 4294967295
    }
 }

Sample response:

{
    "active": 1,
    "code": "1444",
    "color": 4294967295,
    "id": "1bd042be-2458-4612-9fca-f47ae7086fb6",
    "image": {
      "id": "5130ac00-f142-4ec1-a320-8bcaa1ff6ea8",
      "url": "https://api.incust.com/static/46/24/e3f3046640f79506021683de9a8a.jpeg"
    },
    "image_id": "5130ac00-f142-4ec1-a320-8bcaa1ff6ea8",
    "loyalty_id": "87f74cd0-b174-11e6-bfd1-020000ed147d",
    "parent_code": "Drinks",
    "parent_id": "3dfc0bd1-7052-4748-98f1-2f747f70a500",
    "parent_title": "Drinks",
    "price": [
      {
        "id": "86d70a06-7fb9-4ef5-b79d-a36a198ab9c9",
        "price": 1,
        "special_account": {
          "active": 1,
          "goods_items": [
            "1444"
          ],
          "id": "23116258-bffd-4b8c-9c42-a3d8c4a941bd",
          "public_title": "Prepayment for coffee",
          "title": "Prepayment for coffee",
          "type": "goods",
          "unconfirmed_redeem_amount": 0
        },
        "special_account_id": "23116258-bffd-4b8c-9c42-a3d8c4a941bd",
        "type": "special-account"
      },
      {
        "id": "98b78cdc-34a7-452a-8624-6f3bd069770c",
        "price": 7,
        "special_account": {
          "active": 1,
          "id": "c785aa00-d288-4384-814e-f33fc074c7b2",
          "public_title": "Visit reward",
          "title": "Visit reward",
          "type": "punches",
          "unconfirmed_redeem_amount": 0
        },
        "special_account_id": "c785aa00-d288-4384-814e-f33fc074c7b2",
        "type": "special-account"
      },
      {
        "currency": "USD",
        "id": "154264aa-05ad-4d1d-8858-7101ddde451e",
        "price": 1,
        "type": "currency"
      }
    ],
    "sort_order": 0,
    "title": "Coffee",
    "unit": "pcs",
    "variable_price": 0,
    "variable_total": 0,
    "weighing": 0,
    "whole_number": 1
  }

Remarks:
In the case of a well-formed request and correct data, the response will contain the data of the goods with the following fields:
- id: goods ID
- code: goods code
- active: activity flag (1 – yes, 0 – no)
- color: goods color (integer)
- title: goods name
- image:
  - id: picture ID
  - url: link to picture
- additional_images:
  - id: ID of supplementary picture
  - url: link to supplementary picture
- parent_id: parent category ID
- parent_code: code of the parent category
- parent_title: name of the parent category
- price: array of goods prices may contain objects of two types:
  - goods price expressed in currency, contains the following fields:
    - id: price ID
    - type: currency type set to currency
    - currency: currency, in which the price is expressed
    - price: goods price (integer)
  - goods price for customer account
    - id: price ID
    - type: currency type set to special-account
    - price: goods price (integer)
    - special_account_id: customer account ID
    - special_account: an object that contains information about the customer account
      - active: activity flag (1 - yes, 0 - no)
      - id: account ID
      - public_title: localized account name
      - title: account name
      - type: account type. Possible values are 'punches', 'goods', 'money'
      - unconfirmed_redeem_amount: number of goods items that can be written off from the account without a confirmation via SMS
      - goods_items: array of codes of goods linked to the account; is present in response
        only if type is 'goods'
- sort_order: goods sorting order
- unit: units of measurement of goods ('kilograms', 'ounces', 'liters', etc.)
- variable_price: goods price may be modified (1 – yes, 0 – no), specifies that the cashier can enter the goods price
  instead of the one specified in the Control Panel
- variable_total: final goods price (total) may be modified (1 – yes, 0 – no)
- weighing: weighted goods (1 – yes, 0 – no)
- whole_number: goods can be sold only in integral units (1 – yes, 0 – no)

Activate/deactivate goods

URL: /term/loyalty/goods/{id}/active
Method: PATCH
URL parameters:
- id: goods ID
Data parameters:
- active: activity flag (1 – yes, 0 – no)

Sample request:

 {
    "method": "PATCH",
    "url": "https://api.incust.com/v1/term/loyalty/goods/5130ac00-f142-4ec1-a320-8bcaa1ff6ea8/active",
    "headers": {
      "Content-Type": "application/json",
      "Accept-Language": "en",
      "Authorization": "bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6IjAyYmE2YmVhLWVjZjMtMTFlNS1hODNhLTAyMDAwMGVkMTQ3ZCJ9.C7_mAg.KT2RcE4BwIFr8GXvTzVrzKXaODQ"
    },
    "data": {
      "active": 0
    }
 }

Sample response:

{
    "active": 1,
    "code": "1444",
    "color": 4294967295,
    "id": "1bd042be-2458-4612-9fca-f47ae7086fb6",
    "image": {
      "id": "5130ac00-f142-4ec1-a320-8bcaa1ff6ea8",
      "url": "https://api.incust.com/static/46/24/e3f3046640f79506021683de9a8a.jpeg"
    },
    "image_id": "5130ac00-f142-4ec1-a320-8bcaa1ff6ea8",
    "loyalty_id": "87f74cd0-b174-11e6-bfd1-020000ed147d",
    "parent_code": "Drinks",
    "parent_id": "3dfc0bd1-7052-4748-98f1-2f747f70a500",
    "parent_title": "Drinks",
    "price": [
      {
        "id": "86d70a06-7fb9-4ef5-b79d-a36a198ab9c9",
        "price": 1,
        "special_account": {
          "active": 1,
          "goods_items": [
            "1444"
          ],
          "id": "23116258-bffd-4b8c-9c42-a3d8c4a941bd",
          "public_title": "Prepayment for coffee",
          "title": "Prepayment for coffee",
          "type": "goods",
          "unconfirmed_redeem_amount": 0
        },
        "special_account_id": "23116258-bffd-4b8c-9c42-a3d8c4a941bd",
        "type": "special-account"
      },
      {
        "id": "98b78cdc-34a7-452a-8624-6f3bd069770c",
        "price": 7,
        "special_account": {
          "active": 1,
          "id": "c785aa00-d288-4384-814e-f33fc074c7b2",
          "public_title": "Visit reward",
          "title": "Visit reward",
          "type": "punches",
          "unconfirmed_redeem_amount": 0
        },
        "special_account_id": "c785aa00-d288-4384-814e-f33fc074c7b2",
        "type": "special-account"
      },
      {
        "currency": "USD",
        "id": "154264aa-05ad-4d1d-8858-7101ddde451e",
        "price": 10,
        "type": "currency"
      }
    ],
    "sort_order": 0,
    "title": "Coffee",
    "unit": "pcs",
    "variable_price": 0,
    "variable_total": 0,
    "weighing": 0,
    "whole_number": 1
  }

Remarks:
In the case of a well-formed request and correct data, the response will contain the data of the goods with the following fields:
- id: goods ID
- code: goods code
- active: activity flag (1 – yes, 0 – no)
- color: goods color (integer)
- title: goods name
- image:
  - id: picture ID
  - url: link to picture
- additional_images:
  - id: ID of supplementary picture
  - url: link to supplementary picture
- parent_id: parent category ID
- parent_code: code of the parent category
- parent_title: name of the parent category
- price: array of goods prices may contain objects of two types:
  - goods price expressed in currency, contains the following fields:
    - id: price ID
    - type: currency type set to currency
    - currency: currency, in which the price is expressed
    - price: goods price (integer)
  - goods price for customer account
    - id: price ID
    - type: currency type set to special-account
    - price: goods price (integer)
    - special_account_id: customer account ID
    - special_account: an object that contains information about the customer account
      - active: activity flag (1 - yes, 0 - no)
      - id: account ID
      - public_title: localized account name
      - title: account name
      - type: account type. Possible values are 'punches', 'goods', 'money'
      - unconfirmed_redeem_amount: number of goods items that can be written off from the account without a confirmation via SMS
      - goods_items: array of codes of goods linked to the account; is present in response
        only if type is 'goods'
- sort_order: goods sorting order
- unit: units of measurement of goods ('kilograms', 'ounces', 'liters', etc.)
- variable_price: goods price may be modified (1 – yes, 0 – no), specifies that the cashier can enter the goods price
  instead of the one specified in the Control Panel
- variable_total: final goods price (total) may be modified (1 – yes, 0 – no)
- weighing: weighted goods (1 – yes, 0 – no)
- whole_number: goods can be sold only in integral units (1 – yes, 0 – no)

Add supplementary goods image

URL: /term/loyalty/goods/{id}/additional_image/{image_id}
Method: POST
URL parameters:
- id: goods ID
Data parameters:
- picture as binary

Sample request:

 {
    "method": "POST",
    "url": "https://api.incust.com/v1/term/loyalty/goods/1bd042be-2458-4612-9fca-f47ae7086fb6/additional_image/1544b001-e25f-4f94-a32e-abaf801c0875",
    "headers": {
      "Content-Type": "image/jpeg",
      "Accept-Language": "en",
      "Authorization": "bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6IjAyYmE2YmVhLWVjZjMtMTFlNS1hODNhLTAyMDAwMGVkMTQ3ZCJ9.C7_mAg.KT2RcE4BwIFr8GXvTzVrzKXaODQ"
    },

    "data": "picture as binary"
 }

Sample response:

 {
    "active": 1,
    "code": "1444",
    "color": 4294967295,
    "id": "1bd042be-2458-4612-9fca-f47ae7086fb6",
    "image": {
      "id": "5130ac00-f142-4ec1-a320-8bcaa1ff6ea8",
      "url": "https://api.incust.com/static/46/24/e3f3046640f79506021683de9a8a.jpeg"
    },
    "image_id": "5130ac00-f142-4ec1-a320-8bcaa1ff6ea8",
    "additional_images": [
      {
        "id": "1544b001-e25f-4f94-a32e-abaf801c0875",
        "url": "https://api.incust.com/v1/storage/asset/image/1544b001-e25f-4f94-a32e-abaf801c0875?1603782421"
      },
      {
        "id": "223ada05-0e32-428a-bd2b-e9aff541b74b",
        "url": "https://api.incust.com/v1/storage/asset/image/223ada05-0e32-428a-bd2b-e9aff541b74b?1603782421"
      },
      {
        "id": "a1d729d9-2b25-44d0-862f-ec4141000194",
        "url": "https://api.incust.com/v1/storage/asset/image/a1d729d9-2b25-44d0-862f-ec4141000194?1603782421"
      }
    ],
    "loyalty_id": "87f74cd0-b174-11e6-bfd1-020000ed147d",
    "parent_code": "Drinks",
    "parent_id": "3dfc0bd1-7052-4748-98f1-2f747f70a500",
    "parent_title": "Drinks",
    "price": [
      {
        "id": "86d70a06-7fb9-4ef5-b79d-a36a198ab9c9",
        "price": 1,
        "special_account": {
          "active": 1,
          "goods_items": [
            "1444"
          ],
          "id": "23116258-bffd-4b8c-9c42-a3d8c4a941bd",
          "public_title": "Prepayment for coffee",
          "title": "Prepayment for coffee",
          "type": "goods",
          "unconfirmed_redeem_amount": 0
        },
        "special_account_id": "23116258-bffd-4b8c-9c42-a3d8c4a941bd",
        "type": "special-account"
      },
      {
        "id": "98b78cdc-34a7-452a-8624-6f3bd069770c",
        "price": 7,
        "special_account": {
          "active": 1,
          "id": "c785aa00-d288-4384-814e-f33fc074c7b2",
          "public_title": "Visit reward",
          "title": "Visit reward",
          "type": "punches",
          "unconfirmed_redeem_amount": 0
        },
        "special_account_id": "c785aa00-d288-4384-814e-f33fc074c7b2",
        "type": "special-account"
      },
      {
        "currency": "USD",
        "id": "154264aa-05ad-4d1d-8858-7101ddde451e",
        "price": 10,
        "type": "currency"
      }
    ],
    "sort_order": 0,
    "title": "Coffee",
    "unit": "pcs",
    "variable_price": 0,
    "variable_total": 0,
    "weighing": 0,
    "whole_number": 1
  }

Remarks:
The acceptable Content-Type in the header are image/jpeg or image/png
In the case of a well-formed request and correct data, the response will contain the data of the goods with the following fields:
- id: goods ID
- code: goods code
- active: activity flag (1 – yes, 0 – no)
- color: goods color (integer)
- title: goods name
- image:
  - id: picture ID
  - url: link to picture
- additional_images:
  - id: ID of supplementary picture
  - url: link to supplementary picture
- parent_id: parent category ID
- parent_code: code of the parent category
- parent_title: name of the parent category
- price: array of goods prices may contain objects of two types:
  - goods price expressed in currency, contains the following fields:
    - id: price ID
    - type: currency type set to currency
    - currency: currency, in which the price is expressed
    - price: goods price (integer)
  - goods price for customer account
    - id: price ID
    - type: currency type set to special-account
    - price: goods price (integer)
    - special_account_id: customer account ID
    - special_account: an object that contains information about the customer account
      - active: activity flag (1 - yes, 0 - no)
      - id: account ID
      - public_title: localized account name
      - title: account name
      - type: account type. Possible values are 'punches', 'goods', 'money'
      - unconfirmed_redeem_amount: number of goods items that can be written off from the account without a confirmation via SMS
      - goods_items: array of codes of goods linked to the account; is present in response
        only if type is 'goods'
- sort_order: goods sorting order
- unit: units of measurement of goods ('kilograms', 'ounces', 'liters', etc.)
- variable_price: goods price may be modified (1 – yes, 0 – no), specifies that the cashier can enter the goods price
  instead of the one specified in the Control Panel
- variable_total: final goods price (total) may be modified (1 – yes, 0 – no)
- weighing: weighted goods (1 – yes, 0 – no)
- whole_number: goods can be sold only in integral units (1 – yes, 0 – no)

Delete supplementary goods image

URL: /term/loyalty/goods/{id}/additional_image/{image_id}
Method: DELETE
URL parameters:
- id: goods ID
- image_id: ID of the supplementary goods picture
Data parameters:
- none

Sample request:

 {
    "method": "DELETE",
    "url": "https://api.incust.com/v1/term/loyalty/goods/1bd042be-2458-4612-9fca-f47ae7086fb6/additional_image/1544b001-e25f-4f94-a32e-abaf801c0875",
    "headers": {
      "Content-Type": "application/json",
      "Accept-Language": "en",
      "Authorization": "bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6IjAyYmE2YmVhLWVjZjMtMTFlNS1hODNhLTAyMDAwMGVkMTQ3ZCJ9.C7_mAg.KT2RcE4BwIFr8GXvTzVrzKXaODQ"
    }
 }

Sample response:

 {
    "active": 1,
    "code": "1444",
    "color": 4294967295,
    "id": "1bd042be-2458-4612-9fca-f47ae7086fb6",
    "image": {
      "id": "5130ac00-f142-4ec1-a320-8bcaa1ff6ea8",
      "url": "https://api.incust.com/static/46/24/e3f3046640f79506021683de9a8a.jpeg"
    },
    "image_id": "5130ac00-f142-4ec1-a320-8bcaa1ff6ea8",
    "additional_images": [
      {
        "id": "223ada05-0e32-428a-bd2b-e9aff541b74b",
        "url": "https://api.incust.com/v1/storage/asset/image/223ada05-0e32-428a-bd2b-e9aff541b74b?1603782421"
      },
      {
        "id": "a1d729d9-2b25-44d0-862f-ec4141000194",
        "url": "https://api.incust.com/v1/storage/asset/image/a1d729d9-2b25-44d0-862f-ec4141000194?1603782421"
      }
    ],
    "loyalty_id": "87f74cd0-b174-11e6-bfd1-020000ed147d",
    "parent_code": "Drinks",
    "parent_id": "3dfc0bd1-7052-4748-98f1-2f747f70a500",
    "parent_title": "Drinks",
    "price": [
      {
        "id": "86d70a06-7fb9-4ef5-b79d-a36a198ab9c9",
        "price": 1,
        "special_account": {
          "active": 1,
          "goods_items": [
            "1444"
          ],
          "id": "23116258-bffd-4b8c-9c42-a3d8c4a941bd",
          "public_title": "Prepayment for coffee",
          "title": "Prepayment for coffee",
          "type": "goods",
          "unconfirmed_redeem_amount": 0
        },
        "special_account_id": "23116258-bffd-4b8c-9c42-a3d8c4a941bd",
        "type": "special-account"
      },
      {
        "id": "98b78cdc-34a7-452a-8624-6f3bd069770c",
        "price": 7,
        "special_account": {
          "active": 1,
          "id": "c785aa00-d288-4384-814e-f33fc074c7b2",
          "public_title": "Visit reward",
          "title": "Visit reward",
          "type": "punches",
          "unconfirmed_redeem_amount": 0
        },
        "special_account_id": "c785aa00-d288-4384-814e-f33fc074c7b2",
        "type": "special-account"
      },
      {
        "currency": "USD",
        "id": "154264aa-05ad-4d1d-8858-7101ddde451e",
        "price": 10,
        "type": "currency"
      }
    ],
    "sort_order": 0,
    "title": "Coffee",
    "unit": "pcs",
    "variable_price": 0,
    "variable_total": 0,
    "weighing": 0,
    "whole_number": 1
  }

Remarks:
In the case of a well-formed request and correct data, the response will contain the data of the goods with the following fields:
- id: goods ID
- code: goods code
- active: activity flag (1 – yes, 0 – no)
- color: goods color (integer)
- title: goods name
- image:
  - id: picture ID
  - url: link to picture
- additional_images:
  - id: ID of supplementary picture
  - url: link to supplementary picture
- parent_id: parent category ID
- parent_code: code of the parent category
- parent_title: name of the parent category
  - price: array of goods prices may contain objects of two types:
  - goods price expressed in currency, contains the following fields:
    - id: price ID
    - type: currency type set to currency
    - currency: currency, in which the price is expressed
    - price: goods price (integer)
  - goods price for customer account
    - id: price ID
    - type: currency type set to special-account
    - price: goods price (integer)
    - special_account_id: customer account ID
    - special_account: an object that contains information about the customer account
      - active: activity flag (1 - yes, 0 - no)
      - id: account ID
      - public_title: localized account name
      - title: account name
      - type: account type. Possible values are 'punches', 'goods', 'money'
      - unconfirmed_redeem_amount: number of goods items that can be written off from the account without a confirmation via SMS
      - goods_items: array of codes of goods linked to the account; is present in response
        only if type is 'goods'
- sort_order: goods sorting order
- unit: units of measurement of goods ('kilograms', 'ounces', 'liters', etc.)
- variable_price: goods price may be modified (1 – yes, 0 – no), specifies that the cashier can enter the goods price
  instead of the one specified in the Control Panel
- variable_total: final goods price (total) may be modified (1 – yes, 0 – no)
- weighing: weighted goods (1 – yes, 0 – no)
- whole_number: goods can be sold only in integral units (1 – yes, 0 – no)

Add main goods image

URL: /term/loyalty/goods/{id}/photo
Method: POST
URL parameters:
- id: goods ID
Data parameters:
- picture as binary

Sample request:

 {
    "method": "POST",
    "url": "https://api.incust.com/v1/term/loyalty/goods/1bd042be-2458-4612-9fca-f47ae7086fb6/photo",
    "headers": {
      "Content-Type": "image/jpeg",
      "Accept-Language": "en",
      "Authorization": "bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6IjAyYmE2YmVhLWVjZjMtMTFlNS1hODNhLTAyMDAwMGVkMTQ3ZCJ9.C7_mAg.KT2RcE4BwIFr8GXvTzVrzKXaODQ"
    },

    "data": "picture as binary"
 }

Sample response:

 {
    "active": 1,
    "code": "1444",
    "color": 4294967295,
    "id": "1bd042be-2458-4612-9fca-f47ae7086fb6",
    "image": {
      "id": "5130ac00-f142-4ec1-a320-8bcaa1ff6ea8",
      "url": "https://api.incust.com/static/46/24/e3f3046640f79506021683de9a8a.jpeg"
    },
    "image_id": "5130ac00-f142-4ec1-a320-8bcaa1ff6ea8",
    "additional_images": [
      {
        "id": "1544b001-e25f-4f94-a32e-abaf801c0875",
        "url": "https://api.incust.com/v1/storage/asset/image/1544b001-e25f-4f94-a32e-abaf801c0875?1603782421"
      },
      {
        "id": "223ada05-0e32-428a-bd2b-e9aff541b74b",
        "url": "https://api.incust.com/v1/storage/asset/image/223ada05-0e32-428a-bd2b-e9aff541b74b?1603782421"
      },
      {
        "id": "a1d729d9-2b25-44d0-862f-ec4141000194",
        "url": "https://api.incust.com/v1/storage/asset/image/a1d729d9-2b25-44d0-862f-ec4141000194?1603782421"
      }
    ],
    "loyalty_id": "87f74cd0-b174-11e6-bfd1-020000ed147d",
    "parent_code": "Drinks",
    "parent_id": "3dfc0bd1-7052-4748-98f1-2f747f70a500",
    "parent_title": "Drinks",
    "price": [
      {
        "id": "86d70a06-7fb9-4ef5-b79d-a36a198ab9c9",
        "price": 1,
        "special_account": {
          "active": 1,
          "goods_items": [
            "1444"
          ],
          "id": "23116258-bffd-4b8c-9c42-a3d8c4a941bd",
          "public_title": "Prepayment for coffee",
          "title": "Prepayment for coffee",
          "type": "goods",
          "unconfirmed_redeem_amount": 0
        },
        "special_account_id": "23116258-bffd-4b8c-9c42-a3d8c4a941bd",
        "type": "special-account"
      },
      {
        "id": "98b78cdc-34a7-452a-8624-6f3bd069770c",
        "price": 7,
        "special_account": {
          "active": 1,
          "id": "c785aa00-d288-4384-814e-f33fc074c7b2",
          "public_title": "Visit reward",
          "title": "Visit reward",
          "type": "punches",
          "unconfirmed_redeem_amount": 0
        },
        "special_account_id": "c785aa00-d288-4384-814e-f33fc074c7b2",
        "type": "special-account"
      },
      {
        "currency": "USD",
        "id": "154264aa-05ad-4d1d-8858-7101ddde451e",
        "price": 10,
        "type": "currency"
      }
    ],
    "sort_order": 0,
    "title": "Coffee",
    "unit": "pcs",
    "variable_price": 0,
    "variable_total": 0,
    "weighing": 0,
    "whole_number": 1
  }

Remarks:
The acceptable Content-Type in the header are image/jpeg or image/png
In the case of a well-formed request and correct data, the response will contain the data of the goods with the following fields:
- id: goods ID
- code: goods code
- active: activity flag (1 – yes, 0 – no)
- color: goods color (integer)
- title: goods name
- image:
  - id: picture ID
  - url: link to picture
- additional_images:
  - id: ID of supplementary picture
  - url: link to supplementary picture
- parent_id: parent category ID
- parent_code: code of the parent category
- parent_title: name of the parent category
- price: array of goods prices may contain objects of two types:
  - goods price expressed in currency, contains the following fields:
    - id: price ID
    - type: currency type set to currency
    - currency: currency, in which the price is expressed
    - price: goods price (integer)
  - goods price for customer account
    - id: price ID
    - type: currency type set to special-account
    - price: goods price (integer)
    - special_account_id: customer account ID
    - special_account: an object that contains information about the customer account
      - active: activity flag (1 - yes, 0 - no)
      - id: account ID
      - public_title: localized account name
      - title: account name
      - type: account type. Possible values are 'punches', 'goods', 'money'
      - unconfirmed_redeem_amount: number of goods items that can be written off from the account without a confirmation via SMS
      - goods_items: array of codes of goods linked to the account; is present in response
        only if type is 'goods'
- sort_order: goods sorting order
- unit: units of measurement of goods ('kilograms', 'ounces', 'liters', etc.)
- variable_price: goods price may be modified (1 – yes, 0 – no), specifies that the cashier can enter the goods price
  instead of the one specified in the Control Panel
- variable_total: final goods price (total) may be modified (1 – yes, 0 – no)
- weighing: weighted goods (1 – yes, 0 – no)
- whole_number: goods can be sold only in integral units (1 – yes, 0 – no)

Add recommended values for goods

URL: /term/loyalty/goods/{id}/preconfigured_values
Method: PATCH
URL parameters:
- id: goods ID
Data parameters:
- color: goods color (integer)
- currency: currency
- sort_order: sort order
- type: type of recommended value
- value: value

Sample request:

 {
    "method": "PATCH",
    "url": "https://api.incust.com/v1/term/loyalty/goods/089729e3-4033-4fba-af3b-a5f6b03d4705/preconfigured_values",
    "headers": {
      "Content-Type": "application/json",
      "Accept-Language": "en",
      "Authorization": "bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6IjAyYmE2YmVhLWVjZjMtMTFlNS1hODNhLTAyMDAwMGVkMTQ3ZCJ9.C7_mAg.KT2RcE4BwIFr8GXvTzVrzKXaODQ"
    },
    "data": {
      "preconfigured_values": [
        {
          "color": 3224972287,
          "currency": "USD",
          "public_title": {
            "en": "en string",
            "pl": "pl string",
            "ru": "ru string",
            "uk": "uk string"
          },
          "sort_order": 1,
          "type": "currency",
          "value": 20.0
        },
        {
          "color": 3224972290,
          "currency": "UAH",
          "public_title": {
            "en": "en string1",
            "pl": "pl string1",
            "ru": "ru string1",
            "uk": "uk string1"
          },
          "sort_order": 3,
          "type": "currency",
          "value": 200.1
        }
      ]
    }
 }

Sample response:

 [
    {
      "active": 1,
      "code": "1444",
      "color": 4294967295,
      "id": "1bd042be-2458-4612-9fca-f47ae7086fb6",
      "image": {
        "id": "5130ac00-f142-4ec1-a320-8bcaa1ff6ea8",
        "url": "https://api.incust.com/static/46/24/e3f3046640f79506021683de9a8a.jpeg"
      },
      "image_id": "5130ac00-f142-4ec1-a320-8bcaa1ff6ea8",
      "loyalty_id": "87f74cd0-b174-11e6-bfd1-020000ed147d",
      "parent_code": "Drinks",
      "parent_id": "3dfc0bd1-7052-4748-98f1-2f747f70a500",
      "parent_title": "Drinks",
      "price": [
        {
          "currency": "USD",
          "price": 1
        },
        {
          "currency": "RUB",
          "price": 100
        }
      ],
      "preconfigured_values": [
        {
          "color": 3224972290,
          "currency": "UAH",
          "id": "8e0c16b7-075f-4a3f-8976-8961f013ccdb",
          "item_id": "79c3b8cb-6235-458a-a0c2-105e5c5d3df5",
          "public_title": {
            "en": "en string1",
            "pl": "pl string1",
            "ru": "ru string1",
            "uk": "uk string1"
          },
          "sort_order": 3,
          "type": "currency",
          "value": 200.1
        }
      ],
      "sort_order": 0,
      "title": "Coffee",
      "unit": "pcs",
      "variable_price": 0,
      "variable_total": 0,
      "weighing": 0,
      "whole_number": 1
    }
 ]

Remarks:
In the case of a well-formed request and correct data, the response will contain the data of the goods with the following fields:
- id: goods ID
- code: goods code
- active: activity flag (1 – yes, 0 – no)
- color: goods color (integer)
- title: goods name
- image:
  - id: picture ID
  - url: link to picture
- additional_images:
  - id: ID of supplementary picture
  - url: link to supplementary picture
- parent_id: parent category ID
- parent_code: code of the parent category
- parent_title: name of the parent category
- price: array of goods prices may contain objects of two types:
  - goods price expressed in currency, contains the following fields:
    - id: price ID
    - type: currency type set to currency
    - currency: currency, in which the price is expressed
    - price: goods price (integer)
  - goods price for customer account
    - id: price ID
    - type: currency type set to special-account
    - price: goods price (integer)
    - special_account_id: customer account ID
    - special_account: an object that contains information about the customer account
      - active: activity flag (1 - yes, 0 - no)
      - id: account ID
      - public_title: localized account name
      - title: account name
      - type: account type. Possible values are 'punches', 'goods', 'money'
      - unconfirmed_redeem_amount: number of goods items that can be written off from the account without a confirmation via SMS
      - goods_items: array of codes of goods linked to the account; is present in response
        only if type is 'goods'
- sort_order: goods sorting order
- unit: units of measurement of goods ('kilograms', 'ounces', 'liters', etc.)
- variable_price: goods price may be modified (1 – yes, 0 – no), specifies that the cashier can enter the goods price
  instead of the one specified in the Control Panel
- variable_total: final goods price (total) may be modified (1 – yes, 0 – no)
- weighing: weighted goods (1 – yes, 0 – no)
- whole_number: goods can be sold only in integral units (1 – yes, 0 – no)

Add price list for goods

URL: /term/loyalty/goods/{id}/price
Method: PATCH
URL parameters:
- id: goods ID
Data parameters:
- price: array of goods prices, may contain objects of two types:
  - goods price expressed in currency, contains the following fields:
    - type: currency type set to currency
    - currency: currency, in which the price is expressed
    - price: goods price (integer)
  - goods price for customer account
    - type: currency type set to special-account
    - price: goods price (integer)
    - special_account_id: customer account ID
    - special_account: an object that contains information about the customer account
      - active: activity flag (1 - yes, 0 - no)
      - public_title: localized account name
      - title: account name
      - type: account type. Possible values are 'punches', 'goods', 'money'
      - unconfirmed_redeem_amount: number of goods items that can be written off from the account without a confirmation via SMS
      - goods_items: array of codes of goods linked to the account; is present in response
        only if type is 'goods'

Sample request:

 {
    "method": "PATCH",
    "url": "https://api.incust.com/v1/term/loyalty/goods/089729e3-4033-4fba-af3b-a5f6b03d4705/price",
    "headers": {
      "Content-Type": "application/json",
      "Accept-Language": "en",
      "Authorization": "bearer eyJ2ZXJzaW9uIjoxLCJ0ZXJtaW5hbF9pZCI6IjAyYmE2YmVhLWVjZjMtMTFlNS1hODNhLTAyMDAwMGVkMTQ3ZCJ9.C7_mAg.KT2RcE4BwIFr8GXvTzVrzKXaODQ"
    },
    "data": {
      "price": [
        {
          "currency": "USD",
          "price": 1
        },
        {
          "currency": "RUB",
          "price": 100
        }
      ]
    }
 }

Sample response:

 [
    {
      "active": 1,
      "code": "1444",
      "color": 4294967295,
      "id": "1bd042be-2458-4612-9fca-f47ae7086fb6",
      "image": {
        "id": "5130ac00-f142-4ec1-a320-8bcaa1ff6ea8",
        "url": "https://api.incust.com/static/46/24/e3f3046640f79506021683de9a8a.jpeg"
      },
      "image_id": "5130ac00-f142-4ec1-a320-8bcaa1ff6ea8",
      "loyalty_id": "87f74cd0-b174-11e6-bfd1-020000ed147d",
      "parent_code": "Drinks",
      "parent_id": "3dfc0bd1-7052-4748-98f1-2f747f70a500",
      "parent_title": "Drinks",
      "price": [
        {
          "currency": "USD",
          "price": 1
        },
        {
          "currency": "RUB",
          "price": 100
        }
      ],
      "preconfigured_values": [
        {
          "color": 3224972290,
          "currency": "UAH",
          "id": "8e0c16b7-075f-4a3f-8976-8961f013ccdb",
          "item_id": "79c3b8cb-6235-458a-a0c2-105e5c5d3df5",
          "public_title": {
            "en": "en string1",
            "pl": "pl string1",
            "ru": "ru string1",
            "uk": "uk string1"
          },
          "sort_order": 3,
          "type": "currency",
          "value": 200.1
        }
      ],
      "sort_order": 0,
      "title": "Coffee",
      "unit": "pcs",
      "variable_price": 0,
      "variable_total": 0,
      "weighing": 0,
      "whole_number": 1
    }
 ]

Remarks:
In the case of a well-formed request and correct data, the response will contain the data of the goods with the following fields:
- id: goods ID
- code: goods code
- active: activity flag (1 – yes, 0 – no)
- color: goods color (integer)
- title: goods name
- image:
  - id: picture ID
  - url: link to picture
- additional_images:
  - id: ID of supplementary picture
  - url: link to supplementary picture
- parent_id: parent category ID
- parent_code: code of the parent category
- parent_title: name of the parent category
- price: array of goods prices may contain objects of two types:
  - goods price expressed in currency, contains the following fields:
    - id: price ID
    - type: currency type set to currency
    - currency: currency, in which the price is expressed
    - price: goods price (integer)
  - goods price for customer account
    - id: price ID
    - type: currency type set to special-account
    - price: goods price (integer)
    - special_account_id: customer account ID
    - special_account: an object that contains information about the customer account
      - active: activity flag (1 - yes, 0 - no)
      - id: account ID
      - public_title: localized account name
      - title: account name
      - type: account type. Possible values are 'punches', 'goods', 'money'
      - unconfirmed_redeem_amount: number of goods items that can be written off from the account without a confirmation via SMS
      - goods_items: array of codes of goods linked to the account; is present in response
        only if type is 'goods'
- sort_order: goods sorting order
- unit: units of measurement of goods ('kilograms', 'ounces', 'liters', etc.)
- variable_price: goods price may be modified (1 – yes, 0 – no), specifies that the cashier can enter the goods price
  instead of the one specified in the Control Panel
- variable_total: final goods price (total) may be modified (1 – yes, 0 – no)
- weighing: weighted goods (1 – yes, 0 – no)
- whole_number: goods can be sold only in integral units (1 – yes, 0 – no)

Additional functions

Confirmation of customer's phone number

This method is used to verify that the phone number, provided by the customer, really belong to this customer.
The procedure consists of two steps:

Sending of the confirmation code via SMS to the phone number
Validation of the confirmation code, specified by the customer.

Request to send the SMS with the confrmation code

URL:
- /term/phone/verification
Method: POST
URL parameters:
- none
Data parameters:
- phone: phone number

Sample request:

  {
     "method":"POST",
     "url":"https://api.incust.com/v1/term/phone/verification",
     "headers":{
        "Content-Type":"application/json",
        "Accept-Language":"en",
        "Authorization":"bearer eyJ0ZXJtaW5hbF9pZCI6IjAyYmE2YmVhLWVjZjMtMTFlNS1hODNhLTAyMDAwMGVkMTQ3ZCIsInZlcnNpb24iOjF9.C6RfdA.1hcHsBbsYA9Ez38YEhdEJKBvNN8"
     },
     "data":{
        "phone": "+12401234567"
     }
  }

Sample response:

  {
      "code": 0,
      "message": "See the confirmation code in SMS"
  }

Remarks:
In the case of a well-formed request and correct data, a response contains an object with two fields:
- code: response code ('0' upon success)
- message: message text, "See the confirmation code in SMS"

Request for validation of the confirmation code, received from the customer

URL:
- /term/phone/verification
Method: POST
URL parameters:
- none
Data parameters:
- phone: phone number
- pincode: confirmation code

Sample request:

  {
     "method":"POST",
     "url":"https://api.incust.com/v1/term/phone/verification",
     "headers":{
        "Content-Type":"application/json",
        "Accept-Language":"en",
        "Authorization":"bearer eyJ0ZXJtaW5hbF9pZCI6IjAyYmE2YmVhLWVjZjMtMTFlNS1hODNhLTAyMDAwMGVkMTQ3ZCIsInZlcnNpb24iOjF9.C6RfdA.1hcHsBbsYA9Ez38YEhdEJKBvNN8"
     },
     "data":{
        "phone": "+12401234567",
        "pincode": "0000"
     }
  }

Sample response:

  {
      "code": 0,
      "message": "OK"
  }

Remarks:
In the case of a well-formed request and correct data, a response contains an object with two fields:
- code: response code ('0' upon success)
- message: message text, "OK"

Response codes

Below you will find the list of codes of API responses

Code	Description
`0`	Message returned
`1`	Failed to create customer record
`2`	Customer sign in failed
`3`	Token is not correct
`4`	PIN is not correct
`5`	Customer's phone number not found
`6`	Password not correct
`7`	Customer record is suspended
`8`	Customer record not found
`9`	Failed to determine location
`10`	Database read error
`11`	Database write error
`12`	Erroneous field value
`13`	Mandatory field value is missing
`14`	Customer record is blocked
`15`	Customer record is deleted
`16`	User consent required
`18`	Error during image transfer
`20`	PIN generation failed
`21`	PIN sending failed
`22`	PIN is required
`25`	A customer record with such phone number already exists
`26`	A customer record with such email already exists
`27`	Customer record suspended because of sending invalid requests
`28`	A customer record with such ID already exists
`30`	Business not found
`31`	Customer not found
`32`	Referral code not found
`33`	Customer record not found
`34`	No stats available for the specified period
`35`	Error during redeeming inCust bonus points
`36`	Business disabled
`40`	Loyalty program not found
`41`	Loyalty program rule not found
`42`	Goods category not found
`43`	Goods not found
`44`	Goods with this code already exist
`45`	Error of the referral program
`46`	Referral code not found
`47`	Delivery type not found
`48`	Store not found
`49`	Error in delivery information
`50`	Point of Sale not found
`51`	Order not found
`52`	The order already has a transaction
`60`	Terminal not found
`61`	Temrinal disabled
`62`	Such Terminal's or salesperson's phone number already exists
`63`	Terminal does not use a password. Use the API KEY for access.
`64`	Terminal phone number not set
`65`	Terminal temporarily disabled because of sending requests with invalid parameters
`70`	Card category does not exist
`71`	A card with such number is already assigned to another customer
`80`	Loyalty program rule not found
`90`	Message not found
`100`	Transaction not found
`101`	Error during creation of transaction
`102`	Insufficient funds on inCust account. To continue, please, replenish inCust account in the Control Panel.
`103`	Erroneous transaction type
`104`	Transaction registered for another customer
`113`	Incorrect phone number
`114`	Card category not found
`115`	QR code already used or expired
`116`	Invalid QR code
`120`	News not found
`130`	Custom field not found
`131`	Phone Number field not set
`132`	EMail field not set
`140`	Coupon not found
`141`	Coupon series not found
`142`	Unacceptable external code
`143`	Scanned code does not contain inCust coupon
`144`	Coupon already used
`145`	Currency not specified
`146`	Gift certificate not found
`147`	Erroneous coupon series specified
`148`	Gift certificate not valid
`149`	Operation not applicable to the specified type of coupon series
`150`	Invalid or expired link
`151`	Invalid e-mail or the link has expired
`160`	Tourist card already linked to another customer
`170`	Error in check data
`171`	Erroneous payment type
`172`	Error in customer account in check
`173`	Rule not found
`174`	Not enough funds available on the customer account
`180`	Shared object not found
`181`	Sharing of this coupon is not allowed by settings
`182`	You can't add coupon, which has been shared
`185`	Wrong benefit type specified
`190`	The service category of the tourist card has not been found
`191`	The account of the tourist card has not been found
`192`	The service of the tourist card has not been found
`193`	The series of the tourist card has not been found
`194`	Wrong series of the tourist card
`195`	Tourist card not found
`196`	Error when turning off the tourist card
`197`	Tourist card not valid
`198`	The tourist card service is invalid or inactive
`199`	The tourist card service is not available
`200`	This functionality is not available in your current Service Plan
`201`	Service plan not found
`210`	Data amount limit exceeded
`220`	The Order Number field of the payment not found
`230`	Currency exchange rate with specified parameters already exists
`250`	Currency not specified
`260`	Payment card not found
`261`	Payment not found
`262`	Unaccepted payment status
`263`	Unaccepted sum of payment
`264`	Wrong password of the payment card
`265`	Error during payment processing
`266`	Payment details not found
`267`	Loyalty program not set up for use of the payment system
`268`	It is not possible to execute a payment with a mobile app without a customer
`270`	Job not found
`271`	Job already linked to the transaction
`272`	The transaction already has linked jobs
`273`	The transaction has incomplete jobs
`280`	Social network not supported
`281`	Social network token is erroneous
`282`	Authentication in the social network has failed
`300`	Checkout currently serves another customer
`401`	Access denied
`404`	URL not found
`500`	Server error
`9000`	Customer not found
`9001`	Buusiness not found
`9002`	Loyalty program not found
`9003`	Point of Sale not found
`9004`	Such Terminal or salesperson's login already exists
`9005`	Such Terminal or salesperson's phone number already exists
`9006`	inCust Terminal or salesperson not found
`9007`	Transaction not found
`9008`	Coupon not found
`9009`	Error during cancellation of transaction. Transaction not found.
`9010`	Transaction has already been canceled
`9011`	Transaction cancellation error. Bonus points crediting transaction not found.
`9012`	Transaction cancellation error. Bonus points already redeemed.
`9013`	Transaction error. Not enough bonus points on account.
`9014`	Transaction has already been confirmed
`9015`	Transaction error. It is not possible to redeem bonus points in offline mode.
`9016`	Transaction error. Currency for the specified inCust Terminal or salesperson is not set.
`9017`	Transaction error. It is not possible to redeem more bonus points than the sum of the sale.
`9018`	Transaction error. Transaction of this type cannot be canceled.
`9019`	Transaction error. Customer is blacklisted.
`9020`	Transaction error. Customer record is inactive. Waiting for confirmation.
`9021`	Transaction error. Customer is not entitled to redeem bonus points.
`9022`	Transaction error. Customer record is suspended.
`9023`	Transaction error. Customer record is disabled.
`9024`	Bonus points account of the customer not found
`9025`	Referral code not found
`9026`	Customer records are not found in the account list of your business
`9027`	Card category not found
`9029`	Service plan not found
`9030`	Transaction error. Currency not specified.
`9031`	Customer record not found
`9032`	Transaction cancellation error. Insufficient funds on the customer's account.
`9033`	Specified transaction not found
`9034`	Transaction error, insufficient funds on the customer's account.
`9035`	Transaction error. Speicified transaction type cannot be confirmed.
`9036`	Transaction error. It's not possible to add zero or negative amount of bonus points.
`9037`	Transaction error. It's not possible to credit account with zero or negative amount.
`9038`	The monthly sum of bonus points, used to credit the account, must not exceed the total cost of services, used since the beginning of the month.
`9039`	Coupon series not found
`9040`	Coupon already used the maximum number of times, set for the coupon series
`9041`	Coupon already used the maximum number of times, set for one customer
`9042`	Coupon expired
`9043`	All external codes have been used
`9044`	Coupon not found
`9045`	Scanned code does not contain inCust coupon
`9046`	Coupon already used by another customer
`9047`	Currency not specified
`9048`	Coupon series disabled
`9049`	Series code used for coupons with unique coupons
`9050`	Shared object not found
`9051`	Gift certificate not found
`9052`	Sharing of this coupon is not allowed by settings
`9053`	Coupon already used
`9054`	Customer's account is already linked with the business
`9055`	Transaction already commited
`9056`	Tourist cards series has not been found
`9057`	Tourist card has expired
`9058`	Tourist card has been issued the maximum amount of times
`9059`	All tourist card codes have been used
`9060`	Referral program not active
`9061`	The limit of referral codes emission has been exceeded
`9062`	Application not found or not active
`9063`	Order not found
`9064`	Customer record is blocked
`9065`	Customer record is deleted
`9066`	Parameter not found
`9067`	A customer with such phone number already exists
`9068`	A customer with such email address already exists
`9069`	Transaction error. It is not possible to write off more funds that were authorized before.
`9997`	Functionality under development
`9998`	Insufficient funds on inCust account. To continue, please, replenish inCust account in the Control Panel.
`9999`	General SQL error

Usage Of The inCust Terminal API

General information

Authorization

Authorization using login and password

Request for authorization token

Authorization using API KEY

Receiving Terminal settings

Request for retrieval of Terminal settings

Receive customer categories

Request for receiving customer categories

Receiving of customer accounts

Request for receiving customer accounts

Receiving goods and categories

Receiving a list of categories

Receiving the list of goods

Receiving customer data

Request for receiving customer data

Receiving customer identifier from inCust Kiosk

Request for receiving the customer identifier from inCust Kiosk

Receiving customer's questionnaire

Request for receiving customer's questionnaire

Changing customer's questionnaire

Request for changing the customer's questionnaire

Change customer's access type

Request for changing the customer's access type

Change customer's category

Request for changing the customer's category

Customer's consent to use the services

Request to record the customer consent to use the platform services and to allow storage and processing of personal data

Receiving loyalty program rules

Request for receiving the loyalty program rules

Operations with check

Check preparation

Check processing

Request for check processing

Saving of check with finalization

Request for check finalization

Save check

Request for check saving

Reserve check

Request for check saving

Finalize check

Request for finalization of the check

Create and finalize check

Request for check creation with finalization

Reserve funds for check

Request to reserve funds for check

Processing of check with previously reserved funds

Request for check processing

Write off previously reserved funds

Request to write off previously reserved funds

Payments

Query payments by check

Querying payments by check

Add payment to check

request for adding payment to check

Cancel payment by check

Request to cancel the payment by check

Sending of information about payment to app for customers

Request for sending of information about the payment to the app for customers

Retrieval of payment status

Retrieval of payment status

Transactions

Transaction object

Receiving a list of transactions

Request for receiving a list of transactions

Cancellation of transaction

Request for cancellation of transaction

Receive information about the transaction

request to receive information about the transaction

Receive check of the transaction

Request to retrieve information about check of the transaction

Code of the order

Generation of code of order

Request for generation of code of order

Retrieval of the code of the latest order, generated by Terminal app in Steward mode

Request for the latest code, generated by Terminal app in Steward mode

Customer identifiers

Searching for customers by identifiers

Request for searching for customers by identifiers