1. List

You can get the list of labels for your terminal through this service.

POST {{Base Address}}/api/terminal/tag/list

It is enough to send a request to the address provided above. You can use the 'Base Address' as needed for both the test environment and the production environment.

Important: To use the Terminal Label Listing service, you need to send the 'apikeyprivate' and 'apiclientprivate' parameters in the 'Header' field.

PhysicalAPI Address

The header information that should be sent to the service is as follows:

Parameter	Type	Compulsory	Description
apikeyprivate	string	Yes	The Private Key obtained from the merchant panel.
apiclientprivate	string	Yes	The Private Client obtained from the merchant panel.

The body information that should be sent to the service is as follows:

JSON

{
  "pageIndex": 0,
  "pageSize": 10,
  "terminalId": "38e895c3-1a9a-4b73-8816-8557d1d031d6" // Terminal Id
}

The response returned by the service:

Parameter	Type	Description
Result	object	It returns the details of the service.
ErrorCode	int	Error code. If the operation is successful, it returns the value '0'.
Succeeded	bool	It returns a true or false value. If the operation is successful, it returns the value 'true'.
Failed	bool	It returns a true or false value. If the operation is unsuccessful, it returns the value 'true'.
Message	string	If the operation is erroneous, this is the error message related to it. It provides language support based on the locale parameter.
ClientMessage	string	It returns the fixed values of the Paywall error codes. You can perform mapping.

JSON

{
    "Result": {
        "Items": [
            {
                "Id": "3f13e5ab-0087-4267-b8a6-162e6c6963e6",
                "TerminalId": "38e895c3-1a9a-4b73-8816-8557d1d031d6",
                "Name": "Levent Şube 1. Cihaz",
                "Code": "sube_levent_cihaz_1",
                "IsActive": false,
                "CreatedDate": "2024-09-01T19:13:32.546991",
                "UpdateDate": null
            }
        ],
        "Pagination": {
            "CurrentPage": 0,
            "PageCount": 1,
            "PageSize": 10,
            "TotalCount": 1
        }
    },
    "Failed": false,
    "Message": null,
    "ClientMessage": null,
    "Succeeded": true
}