# 1. Payments

<mark style="color:green;">`POST`</mark> `{{Base Address}}/api/payment/list`

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

{% hint style="info" %}
Important: In order to use the **Payment List** service, you need to send the '**apikeyprivate**' and '**apiclientprivate**' parameters in the 'Header' field.

\
[<mark style="color:green;">**PhysicalAPI Address**</mark>](https://developer.paywall.one/payment-orchestration-integration-document/environment)
{% 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="153">Compulsory</th><th>Description</th></tr></thead><tbody><tr><td>apikeyprivate</td><td>string</td><td>Yes</td><td>The Private Key obtained from the merchant panel.</td></tr><tr><td>apiclientprivate</td><td>string</td><td>Yes</td><td>The Private Client obtained from the merchant panel.</td></tr></tbody></table>

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

{% tabs %}
{% tab title="JSON" %}

```json
{
  "pageIndex": 0,
  "pageSize": 10,
  "startDate": "2024-12-23",
  "endDate": "2024-12-30"
}
```

{% endtab %}
{% endtabs %}

**Response returned from the service:**

<table><thead><tr><th width="182">Parameter</th><th width="107.33333333333331">Type</th><th>Description</th></tr></thead><tbody><tr><td>Result</td><td>object</td><td>Returns the information in the details of the service.</td></tr><tr><td>ErrorCode</td><td>int</td><td>Error code. Returns the value '0' if the transaction is successful.</td></tr><tr><td>Succeeded</td><td>bool</td><td>Returns a true or false value. Returns 'true' if the transaction is <mark style="color:green;">successful</mark>.</td></tr><tr><td>Failed</td><td>bool</td><td>Returns a true or false value. Returns 'true' if the transaction is <mark style="color:red;">unsuccessful</mark>.</td></tr><tr><td>Message</td><td>string</td><td>If the transaction is erroneous, this is the message related to the error. It provides language support based on the locale parameter.</td></tr><tr><td>ClientMessage</td><td>string</td><td>Returns the fixed values of the Paywall error codes. You can perform mapping.</td></tr></tbody></table>

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

```json5
{
    "Result": {
        "Items": [
            {
                "Id": "8850e51c-b09a-43fd-855f-83c4037cce45",
                "TerminalId": "38e895c3-1a9a-4b73-8816-8557d1d031d6",
                "ConnectionId": "70b2190b-e47b-455f-b05e-8c132a05534c",
                "ConnectionName": "Varsayılan 1",
                "ProviderId": 20,
                "ProviderName": "Vepara",
                "BrandId": 10,
                "BrandName": "Pavo",
                "RegionId": 1,
                "RegionName": "Turkey",
                "MerchantUniqueCode": "432e795d-1a69-4461-97c8-ebaab658ff55",
                "DisplayCode": "İndirimli Hizmet",
                "Amount": 1.44,
                "PaymentChannelId": 1,
                "PaymentChannelName": "Async",
                "CurrencyId": 1,
                "CurrencyName": "TRY",
                "IP": "::1",
                "PaymentRequestActivityId": "0f7dc0c2-8b3f-466e-b646-22b23e1fa052",
                "PaymentTypeId": 1,
                "PaymentTypeName": "Sale",
                "PaymentStatusId": 2,
                "PaymentStatusName": "SentToDevice",
                "Date": "2024-09-02T19:33:06.199765"
            }
        ],
        "Pagination": {
            "CurrentPage": 0,
            "PageCount": 1,
            "PageSize": 10,
            "TotalCount": 1
        }
    },
    "Failed": false,
    "Message": null,
    "ClientMessage": null,
    "Succeeded": true
}
```

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