2. List (ByRegion)

You can obtain Physical POS providers through this service.

GET {{Base Address}}/api/provider/{regionid}/list

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 Country-Based Provider List 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.

JSON

{
    "Providers": [
        {
            "Brand": 10,
            "Provider": 10,
            "Region": 1,
            "IsActive": true,
            "Name": "Pavo - Papara",
            "IsReporting": true,
            "IsAsyncPayment": true,
            "IsSocketPayment": true,
            "ServiceParameters": [
                {
                    "Name": "Reporting_ApiKey",
                    "Type": "text",
                    "GroupType": 10,
                    "Desciption": "Api Key",
                    "Length": "100",
                    "IsRequired": true,
                    "Value": null
                },
                {
                    "Name": "Reporting_ApiToken",
                    "Type": "password",
                    "GroupType": 10,
                    "Desciption": "Api Token",
                    "Length": "100",
                    "IsRequired": true,
                    "Value": null
                },
                {
                    "Name": "AsyncPayment_ApiKey",
                    "Type": "text",
                    "GroupType": 20,
                    "Desciption": "Api Key",
                    "Length": "100",
                    "IsRequired": true,
                    "Value": null
                },
                {
                    "Name": "AsyncPayment_ApiToken",
                    "Type": "password",
                    "GroupType": 20,
                    "Desciption": "Api Token",
                    "Length": "100",
                    "IsRequired": true,
                    "Value": null
                }
            ]
        },
        {
            "Brand": 10,
            "Provider": 20,
            "Region": 1,
            "IsActive": true,
            "Name": "Pavo - Vepara",
            "IsReporting": true,
            "IsAsyncPayment": true,
            "IsSocketPayment": true,
            "ServiceParameters": [
                {
                    "Name": "Reporting_ApiKey",
                    "Type": "text",
                    "GroupType": 10,
                    "Desciption": "Api Key",
                    "Length": "100",
                    "IsRequired": true,
                    "Value": null
                },
                {
                    "Name": "Reporting_ApiToken",
                    "Type": "password",
                    "GroupType": 10,
                    "Desciption": "Api Token",
                    "Length": "100",
                    "IsRequired": true,
                    "Value": null
                },
                {
                    "Name": "AsyncPayment_ApiKey",
                    "Type": "text",
                    "GroupType": 20,
                    "Desciption": "Api Key",
                    "Length": "100",
                    "IsRequired": true,
                    "Value": null
                },
                {
                    "Name": "AsyncPayment_ApiToken",
                    "Type": "password",
                    "GroupType": 20,
                    "Desciption": "Api Token",
                    "Length": "100",
                    "IsRequired": true,
                    "Value": null
                }
            ]
        }
    ],
    "Brands": [
        {
            "Id": 10,
            "Brand": 10,
            "Name": "Pavo",
            "IsActive": true
        }
    ],
    "Regions": [
        {
            "Id": 1,
            "Region": 1,
            "Name": "Türkiye",
            "IsActive": true
        },
        {
            "Id": 2,
            "Region": 2,
            "Name": "Amerika",
            "IsActive": false
        },
        {
            "Id": 3,
            "Region": 3,
            "Name": "Global",
            "IsActive": false
        }
    ]
}