Retrieve processing terminal | Payroc

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.

**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](https://docs.payroc.com/api/schema/boarding/processing-accounts/create-terminal-order) method. **Note:** If you don't have the processingTerminalId, use our [Retrieve Terminal Order](https://docs.payroc.com/api/schema/boarding/terminal-orders/retrieve) method or our [List Processing Terminals](https://docs.payroc.com/api/schema/boarding/processing-accounts/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.

Authentication

AuthorizationBearer

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

Path parameters

processingTerminalIdstringRequired4-50 characters

Unique identifier that we assigned to the terminal.

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

Polymorphic object that contains information about when and how the terminal closes the batch.

The value of the batchCloseType field determines which variant you should use:

automatic - Terminal automatically closes the batch at a specific time each day.
manual - Merchant uses the terminal to manually close the batch.

applicationSettingsobject

Object that contains the application settings for the solution.

featuresobject

Object that contains the feature settings for the terminal.

programstring<=50 characters

Name of the product and its setup.

gatewayobject

Polymorphic object that contains the gateway settings for the solution.

taxeslist of objects

Array of tax objects that contains the taxes that apply to the merchant's transactions.

securityobject

Object that contains the tokenization settings and AVS settings for the terminal.

receiptNotificationsobject

Object that indicates if the terminal can send email receipts or text receipts.

deviceslist of objects

Array of device objects. Each object contains information about a device using the processing terminal's configuration.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

406

Not Acceptable Error

500

Internal Server Error

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.

1	using Payroc;
2	using System.Threading.Tasks;
3	using Payroc.Boarding.ProcessingTerminals;
4
5	namespace Usage;
6
7	public class Example
8	{
9	public async Task Do() {
10	var client = new PayrocClient();
11
12	await client.Boarding.ProcessingTerminals.RetrieveAsync(
13	new RetrieveProcessingTerminalsRequest {
14	ProcessingTerminalId = "1234001"
15	}
16	);
17	}
18
19	}

1	{
2	"processingTerminalId": "011234001",
3	"status": "active",
4	"timezone": "Pacific/Midway",
5	"batchClosure": {
6	"batchCloseType": "automatic",
7	"batchCloseTime": "23:40"
8	},
9	"applicationSettings": {
10	"invoiceNumberPrompt": true,
11	"clerkPrompt": false
12	},
13	"features": {
14	"enhancedProcessing": {
15	"enabled": true,
16	"transactionDataLevel": "level2",
17	"shippingAddressMode": "fullAddress"
18	},
19	"ebt": {
20	"enabled": true,
21	"ebtType": "foodStamp",
22	"fnsNumber": "3456789"
23	},
24	"pinDebitCashback": false,
25	"tips": {
26	"enabled": false
27	},
28	"recurringPayments": true,
29	"paymentLinks": {
30	"enabled": true,
31	"logoUrl": "LogoPayLink",
32	"footerNotes": "FooterNotesPayLink"
33	},
34	"preAuthorizations": true,
35	"offlinePayments": true
36	},
37	"program": "Payroc Cloud",
38	"gateway": {
39	"gateway": "payroc",
40	"terminalTemplateId": "Roc Services_DX8000"
41	},
42	"taxes": [
43	{
44	"taxRate": 6,
45	"taxLabel": "Sales Tax"
46	}
47	],
48	"security": {
49	"tokenization": false,
50	"avsPrompt": true,
51	"cvvPrompt": true,
52	"avsLevel": "fullAddress"
53	},
54	"receiptNotifications": {
55	"emailReceipt": true,
56	"smsReceipt": false
57	},
58	"devices": [
59	{
60	"manufacturer": "Ingenico",
61	"model": "Axium Dx4000 Tsys",
62	"serialNumber": "DX400-1234",
63	"communicationType": "bluetooth"
64	}
65	]
66	}