# 2. List (ByRegion)

<mark style="color:blue;">`GET`</mark> `{{Base Address}}/api/provider/`<mark style="color:red;">`{regionid}`</mark>`/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.

{% hint style="info" %}
Important: To use the **Country-Based Provider List** service, you must include the '**apikeyprivate**' and '**apiclientprivate**' parameters in the 'Header' field.

\
[<mark style="color:green;">**PhysicalAPI Address**</mark>](/payment-orchestration-integration-document/environment.md)
{% endhint %}

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

<table><thead><tr><th width="243">Parameter</th><th width="106.33333333333331">Type</th><th width="154">Compulsory</th><th>Description</th></tr></thead><tbody><tr><td>apikeyprivate</td><td>string</td><td>Yes</td><td>The Private Key that you obtained from the merchant panel.</td></tr><tr><td>apiclientprivate</td><td>string</td><td>Yes</td><td>The Private Client that you obtained from the merchant panel.</td></tr></tbody></table>

**Response returned from the service:**

<table><thead><tr><th width="182">Parameter</th><th width="115.33333333333331">Type</th><th>Description</th></tr></thead><tbody><tr><td>Result</td><td>object</td><td>It returns the details of the service.</td></tr><tr><td>ErrorCode</td><td>int</td><td>Error code. If the transaction is successful, it returns a value of '0'.</td></tr><tr><td>Succeeded</td><td>bool</td><td>It returns a true or false value. If the transaction is successful, it returns a value of 'true'.</td></tr><tr><td>Failed</td><td>bool</td><td>It returns a true or false value. If the transaction is <mark style="color:red;">unsuccessful</mark>, it returns a value of 'true'.</td></tr><tr><td>Message</td><td>string</td><td>If the transaction is erroneous, this is the error message provided, and it offers language support based on the locale parameter.</td></tr><tr><td>ClientMessage</td><td>string</td><td>It returns the fixed values of Paywall error codes. You can map them.</td></tr></tbody></table>

{% tabs %}
{% tab title="JSON" %}
{% code overflow="wrap" lineNumbers="true" %}

```json5
{
    "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
        }
    ]
}
```

{% endcode %}
{% endtab %}
{% endtabs %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://developer.paywall.one/payment-orchestration-integration-document/physical-pos/1.-provider/2.-list-byregion.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.