Delete all payment devices for a store
DELETE api/payment_devices
Deletes all payment devices for a store.
WARNING: This action deletes every payment device in the store and can't be undone.
Request syntax
delete api/payment_devices?store_id=<store_id>Request parameters
The request accepts the following data in the query string.
| Parameter | Type | Description | Required | Default value |
|---|---|---|---|---|
store_id | Integer | The ID of the store to delete all payment devices from. | Yes | N/A |
Response syntax
[
{
"exporter_job": integer,
"id": integer,
"store_id": integer,
"register_number": integer,
"device_ip": "string",
"device_terminal_id": "string",
"payment_device_type_id": integer,
"mac_address": "string",
"serial_id": "string",
"unit_serial_id": "string",
"device_location": "string",
"product_type": "string",
"group": "string",
"pedpooling": boolean,
"status": "string",
"action_last_executed_by": "string",
"action_last_executed_at_timestamp": "timestamp",
"last_transaction_timestamp": "string",
"firmware_version": "string",
"p2pe_payment_applications": "string",
"p2pe_non_payment_applications": "string",
"hardware_version": "string",
"owner_name": "string",
"last_inspected_date": "string",
"last_inspected_by": "string",
"created_at": "timestamp",
"updated_at": "timestamp"
}
]Response parameters
If the action is successful, an HTTP 200 response is returned with an array in JSON format, with one object for each deleted payment device. All objects share the same exporter_job ID.
| Field | Type | Description |
|---|---|---|
exporter_job | Integer | The ID of the exporter job created for the change. |
id | Integer | The ID of the payment device. |
store_id | Integer | The ID of the store the payment device belongs to. |
register_number | Integer | The register number the payment device is assigned to. |
device_ip | String | The IP address of the payment device. |
device_terminal_id | String | The terminal ID of the payment device. |
payment_device_type_id | Integer | The ID of the payment device type. |
mac_address | String | The MAC address of the payment device. MAC addresses are returned in lowercase. |
serial_id | String | The serial number of the payment device. |
unit_serial_id | String | The unit serial number of the payment device. |
device_location | String | The location of the payment device in the store. |
product_type | String | The product type of the payment device, for example EPP. |
group | String | The group the payment device belongs to. |
pedpooling | Boolean | Whether PED pooling is enabled for the payment device. |
status | String | The status of the payment device, for example Deployed or Awaiting Deployment. |
action_last_executed_by | String | The user who last changed the payment device. |
action_last_executed_at_timestamp | Timestamp | The timestamp of the last change to the payment device. |
last_transaction_timestamp | String | The timestamp of the last transaction on the payment device. |
firmware_version | String | The firmware version of the payment device. |
p2pe_payment_applications | String | The P2PE payment applications on the payment device. |
p2pe_non_payment_applications | String | The P2PE non-payment applications on the payment device. |
hardware_version | String | The hardware version of the payment device. |
owner_name | String | A display name for the payment device, built from the store, register number, device type, serial number, and IP address. |
last_inspected_date | String | The date the payment device was last inspected, in the format MM/DD/YYYY HH:MM:SS TIMEZONE. |
last_inspected_by | String | The user who last inspected the payment device. |
created_at | Timestamp | The timestamp of when the payment device was created. |
updated_at | Timestamp | The timestamp of when the payment device was last updated. |
Errors
The following are errors returned by this API. For a complete list of common errors, see Common errors.
| Code | Message | Cause |
|---|---|---|
| - | - | - |
Examples
Example: Delete all payment devices for a store
This example deletes every payment device in the store with ID 25651. The store had two payment devices.
ruby api.rb <customer_code> delete 'api/payment_devices?store_id=25651'Response
[
{
"exporter_job": 1781620,
"id": 135742,
"store_id": 25651,
"register_number": 2,
"device_ip": "10.53.23.51/26",
"device_terminal_id": null,
"payment_device_type_id": 144,
"mac_address": null,
"serial_id": "DOCS-TEST-0005",
"unit_serial_id": null,
"device_location": null,
"product_type": "EPP",
"group": null,
"pedpooling": true,
"status": "Deployed",
"action_last_executed_by": "test.user",
"action_last_executed_at_timestamp": "2026-10-10T17:48:03.842Z",
"last_transaction_timestamp": null,
"firmware_version": "",
"p2pe_payment_applications": "",
"p2pe_non_payment_applications": "",
"hardware_version": "",
"owner_name": "Store 9901 (Austin/TX): Register 2 (E280FP) Serial number: DOCS-TEST-0005 Ip: 10.53.23.51/26",
"last_inspected_date": null,
"last_inspected_by": null,
"created_at": "2026-10-10T17:48:03.846Z",
"updated_at": "2026-10-10T17:48:03.846Z"
},
{
"exporter_job": 1781620,
"id": 135741,
"store_id": 25651,
"register_number": 1,
"device_ip": "10.53.23.50/26",
"device_terminal_id": null,
"payment_device_type_id": 144,
"mac_address": null,
"serial_id": "DOCS-TEST-0004",
"unit_serial_id": null,
"device_location": null,
"product_type": "EPP",
"group": null,
"pedpooling": true,
"status": "Deployed",
"action_last_executed_by": "test.user",
"action_last_executed_at_timestamp": "2026-10-10T17:48:03.823Z",
"last_transaction_timestamp": null,
"firmware_version": "",
"p2pe_payment_applications": "",
"p2pe_non_payment_applications": "",
"hardware_version": "",
"owner_name": "Store 9901 (Austin/TX): Register 1 (E280FP) Serial number: DOCS-TEST-0004 Ip: 10.53.23.50/26",
"last_inspected_date": null,
"last_inspected_by": null,
"created_at": "2026-10-10T17:48:03.828Z",
"updated_at": "2026-10-10T17:48:03.828Z"
}
]