Retrieve a device configuration

Browse API reference

GET/processing-terminals/{processingTerminalId}/device-configurations/{model}retrieveDeviceConfiguration

Use this method to retrieve configuration details for a device associated with a processing terminal.

Our gateway returns the following details about the configuration:

Supported features
Applications
Certificates and revoked certificates
Visual assets

Parameters

Name	In	Type	Description
`processingTerminalId`Required	path	`string`	Unique identifier that we assigned to the terminal.
`model`Required	path	`string`	Type or model of the device.

Responses

Successful request. Returns the device configuration details.

200 OK · application/json

{
  "applications": [
    {
      "card": "VISA",
      "identifier": "A0000000031010",
      "matchType": "partialVisa",
      "version": "0096"
    },
    {
      "card": "MASTERCARD",
      "identifier": "A0000000041010",
      "matchType": "partialEuropay",
      "version": "0002"
    }
  ],
  "certificates": [
    {
      "certificate": "ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234A",
      "exponent": "03",
      "rid": "A000000003"
    }
  ],
  "manufacturer": "idtech",
  "model": "idtechKioskV",
  "revokedCertificates": [
    {
      "certificate": "ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234A",
      "exponent": "02",
      "rid": "A000000004"
    }
  ],
  "supportsAttended": false,
  "supportsContactless": true,
  "supportsIcc": true,
  "supportsKeyed": false,
  "supportsMagStripe": true,
  "supportsOutputDisplaying": false,
  "supportsOutputPrinting": false,
  "supportsPinEntry": false,
  "supportsUnattended": true,
  "visualAssets": [
    {
      "scope": "logo",
      "type": "image",
      "url": "https://www.example.com/logo.png"
    },
    {
      "scope": "idleScreen",
      "type": "image",
      "url": "https://www.example.com/idle-screen.png"
    }
  ]
}

Response schema · 28 fields

applicationsobject[]
Array of emvApplication objects. Each object contains information about an EMV application supported by the device.
- cardstring
  Card brand associated with the EMV application.
- identifierstring
  Unique identifier of the EMV application, also known as the Application Identifier (AID).
- matchTypestring
  Indicates how the terminal matches the EMV application identifier during card selection. full – The terminal requires an exact match of the full application identifier. partialVisa – The terminal uses partial matching as defined by Visa. partialEuropay – The terminal uses partial matching as defined by Europay and Mastercard.fullpartialVisapartialEuropay
- versionstring
  Version number of the EMV application.
certificatesobject[]
Array of emvCertificate objects. Each object contains information about an EMV certificate used by the device.
- certificatestring
  Certificate data encoded in hexadecimal format.
- exponentstring
  Public key exponent for the certificate.
- ridstring
  Unique identifier of the payment application provider, also known as the Registered Application Provider Identifier (RID).
manufacturerstring
Company that manufactured the device.
modelstringrequired
Type or model of the device.
revokedCertificatesobject[]
Array of emvCertificate objects. Each object contains information about a revoked EMV certificate.
- certificatestring
  Certificate data encoded in hexadecimal format.
- exponentstring
  Public key exponent for the certificate.
- ridstring
  Unique identifier of the payment application provider, also known as the Registered Application Provider Identifier (RID).
supportsAttendedboolean
Indicates if a clerk must operate the device.
supportsContactlessboolean
Indicates if the device can run contactless transactions.
supportsIccboolean
Indicates if the device can read chip cards.
supportsKeyedboolean
Indicates if the device can run keyed transactions.
supportsMagStripeboolean
Indicates if the device can run swiped transactions.
supportsOutputDisplayingboolean
Indicates if the device can display information on a screen.
supportsOutputPrintingboolean
Indicates if the device can print receipts.
supportsPinEntryboolean
Indicates if the device can accept PIN entry.
supportsUnattendedboolean
Indicates if the device can operate without a clerk present.
visualAssetsobject[]
Array of visualAsset objects. Each object contains information about a visual asset that the device displays.
- scopestringrequired
  Location of the visual asset.logoidleScreen
- typestringrequired
  Format of the visual asset.image
- urlstringrequired
  URL of the visual asset.

Invalid request

400 Bad Request · application/problem+json

{
  "detail": "One or more validation errors occurred, see error section for more info",
  "errors": [
    {
      "detail": "invalid date",
      "message": "Expected time, got '' for start_time",
      "parameter": "start_time"
    }
  ],
  "status": 400,
  "title": "Bad request",
  "type": "https://docs.payroc.com/api/errors#bad-request"
}

Response schema · 8 fields

detailstringrequired
Explanation of the problem
errorsobject[]
- detailstring
  Short detail of the validation errors
- messagestring
  Error message
- parameterstring
  The parameter or field causing the issues
statusintegerrequired
Http status code
titlestringrequired
Short description of the issue.
typestringrequired
URI reference identifying the problem type

Identity could not be verified

401 Unauthorized · application/problem+json

{
  "detail": "Your identity could not be verified",
  "status": 401,
  "title": "Not Authorized",
  "type": "https://docs.payroc.com/api/errors#not-authorized"
}

Response schema · 4 fields

detailstringrequired
Explanation of the problem
statusintegerrequired
Http status code
titlestringrequired
Short description of the issue.
typestringrequired
URI reference identifying the problem type

Do not have permissions to perform this action

403 Forbidden · application/problem+json

{
  "detail": "You do not have the required permissions to perform this action",
  "instance": "https://api.payroc.com/v1/exampleResource/3",
  "resource": "exampleResource",
  "status": 403,
  "title": "Forbidden",
  "type": "https://docs.payroc.com/api/errors#forbidden"
}

Response schema · 6 fields

detailstringrequired
Explanation of the problem
instancestring
Resource path the action was attempted on
resourcestring
Resource the action was attempted on
statusintegerrequired
Http status code
titlestringrequired
Short description of the issue.
typestringrequired
URI reference identifying the problem type

Resource not found

404 Not Found · application/problem+json

{
  "detail": "Resource not found",
  "resource": "(The Type of the Resource)",
  "status": 404,
  "title": "Not found",
  "type": "https://docs.payroc.com/api/errors#not-found"
}

Response schema · 5 fields

detailstringrequired
Explanation of the problem
resourcestring
Resource that was not found
statusintegerrequired
Http status code
titlestringrequired
Short description of the issue.
typestringrequired
URI reference identifying the problem type

Not acceptable

406 Not Acceptable · application/problem+json

{
  "detail": "Resource does not support the representation requested",
  "status": 406,
  "title": "Not acceptable",
  "type": "https://docs.payroc.com/api/errors#not-acceptable"
}

Response schema · 4 fields

detailstringrequired
Explanation of the problem
statusintegerrequired
Http status code
titlestringrequired
Short description of the issue.
typestringrequired
URI reference identifying the problem type

An error has occured

500 Internal Server Error · application/problem+json

{
  "detail": "We are unable to process your request at this time",
  "errors": [
    {
      "message": "Service offline"
    }
  ],
  "status": 500,
  "title": "Api error",
  "type": "https://docs.payroc.com/api/errors#api-error"
}

Response schema · 6 fields

detailstringrequired
Explanation of the problem
errorsobject[]
- messagestring
  Error message
statusintegerrequired
Http status code
titlestringrequired
Short description of the issue.
typestringrequired
URI reference identifying the problem type

Used in workflows

configure-a-device