2. Detail

You can obtain the details of your Physical POS connections through this service.

GET {{Base Address}}/api/connection/{ConnectionId}/detail

It will be sufficient to send a request to the address provided above. You can use the 'Base Address' for both the test environment and the live environment as you wish.

Important: To use the Connection Detail service, you must include the 'apikeyprivate' and 'apiclientprivate' parameters in the 'Header' field.

PhysicalAPI Address

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

Parameter
Type
Compulsory
Description

apikeyprivate

string

Yes

The Private Key that you obtained from the merchant panel.

apiclientprivate

string

Yes

The Private Client that you obtained from the merchant panel.

Response returned from the service:

Parameter
Type
Description

Result

object

It returns the details of the service.

ErrorCode

int

Error code. If the transaction is successful, it returns a value of '0'.

Succeeded

bool

It returns a true or false value. If the transaction is successful, it returns a value of 'true'.

Failed

bool

It returns a true or false value. If the transaction is unsuccessful, it returns a value of 'true'.

Message

string

If the transaction is erroneous, this is the error message provided, and it offers language support based on the locale parameter.

ClientMessage

string

It returns the fixed values of paywall error codes. You can map them.

{
    "Result": {
        "Id": "70b2190b-e47b-455f-b05e-8c132a05534c",
        "Name": "Varsayılan 1",
        "DisplayName": "Paywall Uygulamam",
        "BrandId": 10,
        "ProviderId": 10,
        "RegionId": 1,
        "EndOfDayId": 10,
        "IsReporting": true,
        "IsAsyncPayment": true,
        "IsSocketPayment": false,
        "IsConnected": true,
        "IsDelete": false,
        "IsProd": false,
        "ServiceParameters": { // Provider-specific Key/Value
          "Reporting_ApiKey": "***", // It is returned in the Response.
          "Reporting_ApiToken": "***", // It is returned in the Response.
          "AsyncPayment_ApiKey": "***", // It is returned in the Response.
          "AsyncPayment_ApiToken": "***" // It is returned in the Response.
        }
    },
    "Failed": false,
    "Message": null,
    "ClientMessage": null,
    "Succeeded": true
}

Last updated