Retrieve details about a payment device type

GET api/payment_device_types/payment_device_type_id

Retrieves details about a single payment device type.

Request syntax

get api/payment_device_types/<payment_device_type_id>

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.

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
403	`403 Forbidden`	The payment device type ID doesn't exist or isn't available to your organization. The API returns `403` rather than `404` in this case.

Examples

Example: Retrieve details about a payment device type

This example retrieves details about the payment device type with ID 115.

ruby api.rb <customer_code> get api/payment_device_types/115

Response

{
  "id": 115,
  "name": "Generic_VERIFONE_mx_715_form_firm2_app1_app2",
  "model_number": "mx_715",
  "port": 9001,
  "vendor": "VERIFONE",
  "firmware_version": "form_firm2",
  "p2pe_payment_applications": "app1_app2",
  "p2pe_non_payment_applications": "",
  "hardware_version": "",
  "pts_certification_id": null,
  "certification_expiration": null,
  "encryption_type": null,
  "product_type": null,
  "owner_name": "Type: VERIFONE - mx_715",
  "created_at": "2020-09-21T21:57:14.548Z",
  "updated_at": "2020-09-21T21:57:14.548Z"
}

Example: Retrieve a payment device type that isn't available

This example requests a payment device type ID that isn't available to the organization.

ruby api.rb <customer_code> get api/payment_device_types/72

Response

{
    "message": "403 Forbidden"
}