Create many payment devices

POST api/payment_devices/load

Creates one or more payment devices in a single request.

Request syntax

post api/payment_devices/load '{"payment_devices":[{"store_id":<store_id>,"payment_device_type_id":<payment_device_type_id>},{"store_id":<store_id>,"payment_device_type_id":<payment_device_type_id>}]}'

Request parameters

The request accepts the following data in JSON format.

Parameter	Type	Description	Required	Default value
`payment_devices`	Array of Objects	The payment devices to create. Each object accepts the fields in the following table.	Yes	N/A

Each object in the payment_devices array accepts the following fields.

Parameter	Type	Description	Required	Default value
`store_id`	Integer	The ID of the store the payment device belongs to.	Yes	N/A
`payment_device_type_id`	Integer	The ID of the payment device type. For more information, see List all payment device types.	Yes	N/A
`register_number`	Integer	The register number the payment device is associated with. Must be unique within the store. Required if Set Register Number as a required field is enabled in the Stores settings.	No	null
`mac_address`	String	The MAC address of the payment device.	No	null
`group`	String	The group the payment device belongs to.	No	null
`product_type`	String	The product type of the payment device, for example `EPP`.	No	null
`device_location`	String	The location of the payment device within the store.	No	null
`status`	String	The status of the payment device, for example `Deployed` or `Awaiting Deployment`.	No	null
`serial_id`	String	The serial number of the payment device. Must be unique. Required if Set Serial Number as a required field is enabled in the Stores settings.	No	null
`device_ip`	String	The IP address of the payment device. Required if Set IP Address as a required field is enabled in the Stores settings in SC//Reliant Platform Manager.	No	null
`device_terminal_id`	String	The terminal ID of the payment device.	No	null
`active`	Boolean	Whether the payment device is active.	No	null
`last_inspected_date`	String	The date the payment device was last inspected.	No	null
`action_last_executed_by`	String	The user who last performed an action on the payment device.	No	null
`action_last_executed_at_timestamp`	String	The timestamp of the last action performed on the payment device.	No	null
`last_transaction_timestamp`	String	The timestamp of the last transaction processed by the payment device.	No	null
`firmware_version`	String	The firmware version of the payment device.	No	null
`hardware_version`	String	The hardware version of the payment device.	No	null
`p2pe_payment_applications`	String	The P2PE payment applications installed on the payment device.	No	null
`p2pe_non_payment_applications`	String	The P2PE non-payment applications installed on the payment device.	No	null

Response syntax

{
    "success": boolean,
    "records": [
        {
            "record": {
                "id": integer,
                "store_id": integer,
                "register_number": integer,
                "device_ip": "string",
                "device_terminal_id": "string",
                "active": boolean,
                "created_at": "timestamp",
                "updated_at": "timestamp",
                "payment_device_type_id": integer,
                "mac_address": "string",
                "serial_id": "string",
                "device_location": "string",
                "product_type": "string",
                "group": "string",
                "status": "string",
                "owner_name": "string",
                "status_last_update": "timestamp",
                "serial_id_processed": "string",
                "last_inspected_date": "string",
                "last_serial_error": "string",
                "action_last_executed_by": "string",
                "action_last_executed_at_timestamp": "timestamp",
                "last_inspected_by": "string",
                "last_transaction_timestamp": "string",
                "unit_serial_id": "string",
                "pedpooling": boolean,
                "p2pe_payment_applications": "string",
                "p2pe_non_payment_applications": "string",
                "hardware_version": "string",
                "firmware_version": "string"
            }
        }
    ],
    "exporter_job": integer
}

Response parameters

If the action is successful, an HTTP 201 response is returned. The following data is returned in JSON format.

Field	Type	Description
`success`	Boolean	Whether the request succeeded.
`records`	Array of objects	One object for each payment device created. Each object contains a `record` object with the details of the created payment device.
`exporter_job`	Integer	The ID of the exporter job created for the change.

Errors

The following are errors returned by this API. For a complete list of common errors, see Common errors.

Code	Message	Cause
-	-	-

Examples

Example: Create two payment devices

This example creates payment devices on registers 902 and 903 in the store with ID 25511.

ruby api.rb <customer_code> post api/payment_devices/load '{"payment_devices":[{"store_id":25511,"payment_device_type_id":144,"register_number":902,"device_ip":"10.53.23.45/26","serial_id":"DOCS-TEST-0002","status":"Deployed"},{"store_id":25511,"payment_device_type_id":144,"register_number":903,"device_ip":"10.53.23.46/26","serial_id":"DOCS-TEST-0003","status":"Deployed"}]}'

Response

{
  "success": true,
  "records": [
    {
      "record": {
        "id": 135739,
        "store_id": 25511,
        "register_number": 902,
        "device_ip": "10.53.23.45/26",
        "device_terminal_id": null,
        "active": true,
        "created_at": "2026-10-10T17:06:11.120Z",
        "updated_at": "2026-10-10T17:06:11.120Z",
        "payment_device_type_id": 144,
        "mac_address": null,
        "serial_id": "DOCS-TEST-0002",
        "device_location": null,
        "product_type": "EPP",
        "group": null,
        "status": "Deployed",
        "owner_name": "Store 2324 (Honolulu/HI): Register 902 (E280FP) Serial number: DOCS-TEST-0002 Ip: 10.53.23.45/26",
        "status_last_update": "2026-10-10T17:06:11.112Z",
        "serial_id_processed": "DOCSTEST0002",
        "last_inspected_date": null,
        "last_serial_error": null,
        "action_last_executed_by": "test.user",
        "action_last_executed_at_timestamp": "2026-10-10T17:06:11.112Z",
        "last_inspected_by": null,
        "last_transaction_timestamp": null,
        "unit_serial_id": null,
        "pedpooling": true,
        "p2pe_payment_applications": "",
        "p2pe_non_payment_applications": "",
        "hardware_version": "",
        "firmware_version": ""
      }
    },
    {
      "record": {
        "id": 135740,
        "store_id": 25511,
        "register_number": 903,
        "device_ip": "10.53.23.46/26",
        "device_terminal_id": null,
        "active": true,
        "created_at": "2026-10-10T17:06:11.147Z",
        "updated_at": "2026-10-10T17:06:11.147Z",
        "payment_device_type_id": 144,
        "mac_address": null,
        "serial_id": "DOCS-TEST-0003",
        "device_location": null,
        "product_type": "EPP",
        "group": null,
        "status": "Deployed",
        "owner_name": "Store 2324 (Honolulu/HI): Register 903 (E280FP) Serial number: DOCS-TEST-0003 Ip: 10.53.23.46/26",
        "status_last_update": "2026-10-10T17:06:11.143Z",
        "serial_id_processed": "DOCSTEST0003",
        "last_inspected_date": null,
        "last_serial_error": null,
        "action_last_executed_by": "test.user",
        "action_last_executed_at_timestamp": "2026-10-10T17:06:11.143Z",
        "last_inspected_by": null,
        "last_transaction_timestamp": null,
        "unit_serial_id": null,
        "pedpooling": true,
        "p2pe_payment_applications": "",
        "p2pe_non_payment_applications": "",
        "hardware_version": "",
        "firmware_version": ""
      }
    }
  ],
  "exporter_job": 1781590
}