Modify a terminal's configuration. Note that changes in configuration will only be reflected on your physical terminal when it has performed an online update. You cannot modify the configuration of an inactive or deleted terminal. NOTE: the currency
parameter for Terminals only supports USD
.
A successful terminal modification response.
id required | string [ 1 .. 255 ] characters ID of the object or resource. | ||||||
resource required | string Helps organize information by identifying the resource type of the object data.
| ||||||
path required | string The HTTP path of the resource. The path can be used to retrieve details about the resource and perform actions on it. | ||||||
required | object or null Details the owner resource and owner path. | ||||||
api_version required | string | ||||||
status required | string The status of the terminal. Active means the terminal is able to accept authorizations. Inactive means the terminal has been deactivated and is unable to accept payments (this can occur for risk and fraud related reasons).
| ||||||
serial_number required | string [ 1 .. 32 ] characters ^[a-zA-Z0-9-]+$ The serial number of the terminal. | ||||||
model required | string The model of the physical terminal. Note: Models
| ||||||
reference_id required | string or null [ 1 .. 255 ] characters | ||||||
last_call_home required | integer or null <int64> >= 0 The epoch timestamp of the last time this terminal called home. Null if the terminal has never done so. | ||||||
terminal_application_version required | string or null The version of the application running on the terminal. | ||||||
required | object | ||||||
gateway_id | string [ 1 .. 255 ] characters Unique identifier of the terminal used by our payment gateway |
INVALID_PARAMS
NOT_AUTHORIZED
UNEXPECTED_ERROR
{- "reference_id": "abc12345",
- "terminal_configuration": {
- "contactless_payments": {
- "enabled": true,
- "credit_debit_preference": "credit"
}
}
}
{- "id": "eaf1ef26-ea2d-4be3-b990-ec2c410b54de",
- "resource": "terminals",
- "path": "/terminals/eaf1ef26-ea2d-4be3-b990-ec2c410b54de",
- "owner": {
- "id": "0ef0dcd6-a2c6-49c4-9051-bbbe5c6c36e2",
- "path": "/accounts/0ef0dcd6-a2c6-49c4-9051-bbbe5c6c36e2",
- "resource": "accounts"
}, - "api_version": "3.0",
- "status": "active",
- "serial_number": "FA00332-1000138",
- "model": "verifone_p400",
- "reference_id": "abc12345",
- "last_call_home": 1549570307,
- "terminal_application_version": "1.27.311",
- "terminal_configuration": {
- "name": "Front Desk",
- "receipt_header_merchant_name": null,
- "maintenance_window": {
- "start": 0,
- "duration": 1
}, - "manual_entry_configuration": {
- "avs_prompt_enabled": true,
- "cvd_prompt_enabled": true
}, - "address": {
- "city": "Redwood City",
- "country": "US",
- "line1": "250 Convention Way",
- "line2": "Suite 200",
- "postal_code": "94063",
- "region": "CA"
}, - "timezone": "US/Pacific",
- "currency": "USD",
- "supported_card_brands": [
- "visa",
- "american_express",
- "discover",
- "mastercard",
- "diners_club",
- "jcb"
], - "credit_debit_preference": "prompt",
- "sim_card_id": "5aad45c2-d128-466a-aae3-d42fef57e2f7",
- "tip": {
- "mode": "prompt_on_terminal",
- "terminal_display": {
- "amount_guide_type": "percentage_guide",
- "percentage_guide": {
- "show_amount": false,
- "percentage_low": 15,
- "percentage_medium": 18,
- "percentage_high": 20
}
}
}, - "signature_required": true,
- "contactless_payments": {
- "enabled": true,
- "credit_debit_preference": "credit"
}, - "quick_chip": {
- "enabled": true
}, - "deferred_authorization": {
- "enabled": true,
- "international_enabled": true,
- "max_transaction_count": 20,
- "max_total_amount": 250000,
- "max_transaction_amount": 12500,
- "supported_card_entry_modes": [
- "chip",
- "contactless"
]
}
}, - "gateway_id": "AB00004D3Z"
}