---
title: "Device Parameter For Virtual Terminal Device"
method: POST
path: "/api/valor/deviceParameter?vt"
---

# Device Parameter For Virtual Terminal Device

`POST /api/valor/deviceParameter?vt`

## Headers

- `Authorization` string, required
- `isv-secret-key` string

## Request body

- object
  - `epi` string, required — EPI is an end point identifier, Identify the device on valor infrastructure, it's a 10 digit number starts with 2
  - `data` object, required
    - `tip_enabled` boolean — Excepted either true or false.
    - `tip_on_screen` boolean — Excepted either true or false.
    - `tip_options` integer[] — The Input must fall within the range of 1 to 350 and must contain exactly four unique numeric values.
    - `max_tip_percentage` integer — The Input must fall within the range of 1 to 9999.
    - `tax_enabled` boolean — Excepted either true or false.
    - `state_tax` number, float — The Input must fall within the range of 0.001 to 15.000.
    - `city_tax` number, float — The Input must fall within the range of 0.001 to 15.000.
    - `reduced_tax` number, float — The Input must fall within the range of 0.001 to 15.000.
    - `enable_for_all_debit_card` boolean — Excepted either true or false.
    - `customer_fee_disclosure` boolean — Excepted either true or false.
    - `include_tip_on_screen` boolean — Excepted either true or false.
    - `apply_fee_with_tip` boolean — Excepted either true or false.
    - `include_tax` boolean — Excepted either true or false.
    - `apply_fee_with_tax` boolean — Excepted either true or false.
    - `show_remove_fee` boolean — Excepted either true or false.
    - `prompt_password_to_remove_fee` boolean — Excepted either true or false.
    - `email_settlement_report` boolean — Excepted either true or false.
    - `avs` integer — <table class="valor_module_table"> <tr> <th>AVS</th> <th>Options</th> </tr> <tr> <td>None</td> <td>1</td> </tr> <tr> <td>Zip Only</td> <td>2</td> </tr> <tr> <td>Address Only</td> <td>3</td> </tr> <tr> <td>Zip & Address</td> <td>4</td> </tr> </table>
    - `avs_action_on_failed` integer — <table class="valor_module_table"> <tr> <th>AVS Action on Failed</th> <th>Options</th> </tr> <tr> <td>Decline</td> <td>1</td> </tr> <tr> <td>Approve and Notify</td> <td>2</td> </tr> </table>
    - `password_for_refund_enabled` boolean — Excepted either true or false.
    - `password_for_refund_amount` integer — The Input must fall within the range of 1 to 9999.
    - `partial_approval` boolean — Excepted either true or false.
    - `descriptor_enabled` boolean — Excepted either true or false.
    - `descriptor_label` string — The Input should consist of 1 to 21 characters at most.
    - `application_options` integer — <table class="valor_module_table"> <tr> <th>Application Type</th> <th>Options</th> </tr> <tr> <td>Default</td> <td>1</td> </tr> <tr> <td>Dual Pricing</td> <td>2</td> </tr> <tr> <td>Bin Base Surcharge</td> <td>3</td> </tr> <tr> <td>Falcon Manual Tax</td> <td>4</td> </tr> <tr> <td>Falcon Exclusive Tax</td> <td>5</td> </tr> <tr> <td>Falcon Inclusive Tax</td> <td>6</td> </tr> </table>
    - `validate_fee` boolean — Excepted either true or false.
    - `header_two` string — The Input should consist of 1 to 26 characters at most.
    - `header_three` string — The Input should consist of 1 to 25 characters at most.
    - `header_four` string — The Input should consist of 1 to 25 characters at most.
    - `header_five` string — The Input should consist of 1 to 25 characters at most.
    - `header_six` string — The Input should consist of 1 to 25 characters at most.
    - `header_seven` string — The Input should consist of 1 to 25 characters at most.
    - `footer_one` string — The Input should consist of 1 to 24 characters at most.
    - `footer_two` string — The Input should consist of 1 to 24 characters at most.
    - `footer_three` string — The Input should consist of 1 to 24 characters at most.
    - `footer_four` string — The Input should consist of 1 to 24 characters at most.
    - `footer_five` string — The Input should consist of 1 to 24 characters at most.
    - `footer_six` string — The Input should consist of 1 to 24 characters at most.
    - `footer_seven` string — The Input should consist of 1 to 24 characters at most.
    - `footer_eight` string — The Input should consist of 1 to 24 characters at most.
    - `footer_nine` string — The Input should consist of 1 to 24 characters at most.
    - `footer_ten` string — The Input should consist of 1 to 24 characters at most.
    - `enable_disclaimer` boolean — Excepted either true or false.
    - `disclaimer_one` string — The Input should consist of 1 to 24 characters at most.
    - `disclaimer_two` string — The Input should consist of 1 to 24 characters at most.
    - `disclaimer_three` string — The Input should consist of 1 to 24 characters at most.
    - `disclaimer_four` string — The Input should consist of 1 to 24 characters at most.
    - `disclaimer_five` string — The Input should consist of 1 to 24 characters at most.
    - `disclaimer_six` string — The Input should consist of 1 to 24 characters at most.
    - `disclaimer_seven` string — The Input should consist of 1 to 24 characters at most.
    - `disclaimer_eigth` string — The Input should consist of 1 to 24 characters at most.
    - `disclaimer_nine` string — The Input should consist of 1 to 24 characters at most.
    - `disclaimer_ten` string — The Input should consist of 1 to 24 characters at most.
    - `batch_out_enabled` boolean — Excepted either true or false.
    - `batch_out_timer` string — The Input must be in 15-min intervals, from '00:00 AM' to '11:45 PM'.
    - `show_device_lable` boolean — Excepted either true or false.
    - `surcharge_label` string — The Input should consist of 1 to 26 characters at most.
    - `visa_ten_dollar` boolean — Excepted either true or false.
    - `card_type` integer — Expected values are 1, 2 or 3.
    - `bypass_cvv_entry` boolean — Excepted either true or false.
    - `disable_merchant_copy_sms` boolean — Excepted either true or false.
    - `disable_customer_copy_sms` boolean — Excepted either true or false.
    - `disable_merchant_copy_email` boolean — Excepted either true or false.
    - `disable_customer_copy_email` boolean — Excepted either true or false.
    - `invoice_number_required` boolean — Excepted either true or false.
    - `image_capture_option_txn` integer — Expected values are 1, 2 or 3.
    - `email_required` boolean — Excepted either true or false.
    - `phone_required` boolean — Excepted either true or false.
    - `food_amount` boolean — Excepted either true or false.
    - `image_capture_sale` boolean — Excepted either true or false.
    - `image_capture_einvoice` boolean — Excepted either true or false.
    - `allow_skip_with_reason` boolean — Excepted either true or false.
    - `disclaimer_vt_credit` boolean — Excepted either true or false.
    - `disclaimer_vt_debit` boolean — Excepted either true or false.
    - `disclaimer_credit_einvoice` boolean — Excepted either true or false.
    - `disclaimer_debit_einvoice` boolean — Excepted either true or false.
    - `disclaimer_credit_label` string — The Input should consist of 1 to 200 characters at most.
    - `disclaimer_debit_label` string — The Input should consist of 1 to 200 characters at most.
    - `customer_satisfaction_survey` boolean — Excepted either true or false.
    - `company_name_enabled` boolean — Excepted either true or false.
    - `company_name_text` string — The Input should consist of 1 to 25 characters at most.
    - `company_name_option` integer — Expected values are 1 or 2.
    - `additional_input_enabled` boolean — Excepted either true or false.
    - `additional_input` object[]
      - `display_text` string — The input should be a string of 1 to 16 alphanumeric characters without special characters.
      - `text_format` integer — Expected values are 1 or 2.
      - `min_length` boolean — The Input must fall within the range of 0 to 15.
      - `max_length` integer — The Input must fall within the range of 1 to 16.
      - `mandatory` integer — Expected values are 1 or 2.
      - `duplicate_check` integer — Expected values are 1 or 2.
    - `mandatory_card_holder_name` boolean — Excepted either true or false.
    - `allow_customer_line_item` boolean — Excepted either true or false.
    - `envoice_display_merchant_logo` boolean — Excepted either true or false.
    - `show_flex_factor_popup` boolean — Excepted either true or false.
    - `server_clerk_setup` boolean — Excepted either true or false.
    - `clerk_mandate` boolean — Excepted either true or false.
    - `add_clerk_details` object
      - `label` string — The Input should consist of 1 to 10 characters at most.
      - `options` object[]
        - `serverid` string — The Input must fall within the range of 1 to 999.
        - `servername` string — The Input should consist of 1 to 14 characters at most.
    - `include_cash` boolean — Excepted either true or false.
    - `include_tax_for_cash` boolean — Excepted either true or false.
    - `show_remove_tax` boolean — Excepted either true or false.
    - `prompt_password_to_remove_tax` boolean — Excepted either true or false.
    - `duplicate_transaction_check` integer — Expected values are 1, 2 or 3.
    - `duplicate_transaction_action` integer — Expected values are 1 or 2.
    - `generate_otp_paynow_link` boolean — Excepted either true or false.
    - `avs_for_einvoice` boolean — Excepted either true or false.
  - `associate_user_name` string — ISO user name (Alphanumeric length of 35 chars)

## Response `200`

200

- object
  - `message` string
  - `status` boolean
  - `code` integer
  - `data` boolean

## Other responses

- `400` — 400

---

[API](https://skmtc.net/valorpaytech/apis/ecommerce-api.md) · [All operations](https://skmtc.net/valorpaytech/apis/ecommerce-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/valorpaytech/ecommerce-api/revisions/c6468b606325/schema)