List all payment device types

GET api/payment_device_types

Lists all payment device types for your organization.

Request syntax

get api/payment_device_types

Request parameters

The request accepts no parameters.

Response syntax

[
    {
        "id": integer,
        "name": "string",
        "model_number": "string",
        "port": integer,
        "vendor": "string",
        "firmware_version": "string",
        "p2pe_payment_applications": "string",
        "p2pe_non_payment_applications": "string",
        "hardware_version": "string",
        "pts_certification_id": "string",
        "certification_expiration": "string",
        "encryption_type": "string",
        "product_type": "string",
        "owner_name": "string",
        "created_at": "timestamp",
        "updated_at": "timestamp"
    }
]

Response parameters

If the action is successful, an HTTP 200 response is returned. The following data is returned in JSON format as an array, with one object for each payment device type.

Field	Type	Description
`id`	Integer	The payment device type ID. Use this value as the `payment_device_type_id` when creating or updating a payment device.
`name`	String	The name of the payment device type.
`model_number`	String	The model number of the payment device type.
`port`	Integer	The port used by payment devices of this type.
`vendor`	String	The vendor of the payment device type, for example `VERIFONE` or `Ingenico`.
`firmware_version`	String	The firmware version of the payment device type.
`p2pe_payment_applications`	String	The P2PE payment applications for the payment device type.
`p2pe_non_payment_applications`	String	The P2PE non-payment applications for the payment device type.
`hardware_version`	String	The hardware version of the payment device type.
`pts_certification_id`	String	The PCI PTS certification ID of the payment device type.
`certification_expiration`	String	The date the PCI PTS certification expires, in the format `MM/DD/YYYY`.
`encryption_type`	String	The encryption type used by the payment device type, for example `3DES DUKPT` or `VSP`.
`product_type`	String	The product type of the payment device type, for example `EPP` or `PED`.
`owner_name`	String	The display name generated for the payment device type, in the format `Type: <name> - <model_number>`.
`created_at`	Timestamp	The timestamp of when the payment device type was created.
`updated_at`	Timestamp	The timestamp of when the payment device type was last updated. Upon initial creation, the `created_at` and `updated_at` values will be the same.

Errors

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

Code	Message	Cause
-	-	-

Examples

Example: List all payment device types

This example lists all payment device types. The response has been shortened.

ruby api.rb <customer_code> get api/payment_device_types

Response

[
  {
    "id": 144,
    "name": "E280FP",
    "model_number": "E280FP",
    "port": 12345,
    "vendor": "VERIFONE",
    "firmware_version": "",
    "p2pe_payment_applications": "",
    "p2pe_non_payment_applications": "",
    "hardware_version": "",
    "pts_certification_id": null,
    "certification_expiration": null,
    "encryption_type": "VSP",
    "product_type": "EPP",
    "owner_name": "Type: VERIFONE - E280FP",
    "created_at": "2024-04-24T21:13:29.203Z",
    "updated_at": "2024-04-24T21:13:29.203Z"
  },
  {
    "id": 147,
    "name": "VERIFONE_Mx915",
    "model_number": "VERIFONE_Mx915",
    "port": 9001,
    "vendor": "VERIFONE",
    "firmware_version": "",
    "p2pe_payment_applications": "",
    "p2pe_non_payment_applications": "",
    "hardware_version": "",
    "pts_certification_id": null,
    "certification_expiration": null,
    "encryption_type": "3DES DUKPT",
    "product_type": "EPP",
    "owner_name": "Type: VERIFONE - VERIFONE_Mx915",
    "created_at": "2024-04-24T21:14:45.819Z",
    "updated_at": "2024-04-24T21:14:45.819Z"
  }
]