processingTerminals

Retrieve processing terminal

Changed on

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.
get/processing-terminals/{processingTerminalId}

Request

  • Base URL
    https://api.payroc.com/v1
  • URL
    https://api.payroc.com/v1/processing-terminals/{processingTerminalId}
  • Auth
    HTTP bearer

Path parameters

processingTerminalIdstring required

Unique identifier that we assigned to the terminal.

Response

Successful request. Returns the processing terminal.

processingTerminalIdstring required

Unique identifier that we assigned to the processing terminal.

status'active' | 'inactive' required

Indicates if the processing terminal is active.

timezone'Pacific/Midway' | 'Pacific/Honolulu' | 'America/Anchorage' | 'America/Los_Angeles' | 'America/Denver' | 'America/Phoenix' | 'America/Chicago' | 'America/Indiana/Indianapolis' | 'America/New_York' required

Indicates the timezone within which transactions will be processed for this terminal

programstring

Name of the product and its setup.

Changes

  • 9fc1e1d5b4a8Revision changes
    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security Bearer was added to the API

  • 9af893904873Revision changes
    • info

      api operation id retrieve removed and replaced with processingTerminals_retrieve