SchemaBoardingProcessing Terminals

Retrieve processing terminal

Important: You can retrieve a processing terminal only if the terminal order was created using the Payroc API.

Use this method to retrieve information about a processing terminal.

To retrieve a processing terminal, you need its processingTerminalId. Our gateway returned the processingTerminalId in the response of the Create Terminal Order method.

Note: If you don’t have the processingTerminalId, use our Retrieve Terminal Order method or our List Processing Terminals method to search for the processing terminal.

Our gateway returns the following information about the processing terminal:

  • Status indicating whether the terminal is active or inactive.
  • Configuration settings, including gateway settings and application settings.
  • Features, receipt settings, and security settings.
  • Devices that use the processing terminal’s configuration.

Path parameters

processingTerminalIdstringRequired>=4 characters<=50 characters
Unique identifier that we assigned to the terminal.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Response

Successful request. Returns the processing terminal.
processingTerminalIdstring
Unique identifier that we assigned to the processing terminal.
statusenum
Indicates if the processing terminal is active.
Allowed values:
timezoneenum
Time zone of the processing terminal.
batchClosureobject
Object that contains information about when and how the terminal closes the batch.
applicationSettingsobject
Object that contains the application settings for the solution.
featuresobject
Object that contains the feature settings for the terminal.
programstring or null<=50 characters
Name of the product and its setup.
gatewayobject or null
Object that contains the gateway settings for the solution.
taxeslist of objects or null
Array of tax objects that contains the taxes that apply to the merchant's transactions.
securityobject or null
Object that contains the tokenization settings and AVS settings for the terminal.
receiptNotificationsobject or null
Object that indicates if the terminal can send email receipts or text receipts.
deviceslist of objects or null
Array of device objects. Each object contains information about a device using the processing terminal's configuration.

Errors