2. Add

You can use this service to add labels to your terminals

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

It is sufficient 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 Adding 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:

{
  "TerminalId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "Name": "Levent Şube 2. Cihaz",
  "Code": "levent_sube_cihaz_2"
}
Parameter
Type
Compulsory
Length
Description
TerminalId

Guid

Yes

-

The ID of your terminal.

Name

string

Yes

100

The label name.

Code

string

Yes

25

The unique code for the label.

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 faulty, 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.

{
    "result": {
        "status": true
    },
    "failed": false,
    "message": null,
    "clientMessage": null,
    "succeeded": true
}

Last updated