# 20. Payment Listing

## Payment Listing

<mark style="color:blue;">`GET`</mark> `{{Private Base Address}}/api/paywall/private/vpos/transaction/list`

{% hint style="info" %}
Important: To use the Payment Listing service, you must include the parameters **apikeyprivate** and **apiclientprivate** in the Header section.\
\
[<mark style="color:green;">**PaymentPrivateAPI Address**</mark>](https://developer.paywall.one/payment-orchestration-integration-document/environment)
{% endhint %}

{% hint style="warning" %}
The Payment Listing service only lists completed transactions from the most recent T-1 day. Transactions from the current day that have not yet been closed are not included in this service.
{% endhint %}

**Sent Headers Information:**

<table><thead><tr><th width="173">Parameter</th><th width="110">Type</th><th width="135.80078125">Compolsory</th><th width="403">Description</th></tr></thead><tbody><tr><td>apikeyprivate</td><td>string</td><td>Yes</td><td>Public Key you obtained from the merchant panel.</td></tr><tr><td>apiclientprivate</td><td>string</td><td>Yes</td><td>Public Client you obtained from the merchant panel.</td></tr><tr><td>page</td><td>int</td><td>Yes</td><td>Page number you want to list<br><br><strong>Min:</strong> 1</td></tr><tr><td>pageSize</td><td>int</td><td>Yes</td><td>Number of items per page you want to list<br><br><strong>Maks:</strong> 1000</td></tr><tr><td>date</td><td>DateTime</td><td>Yes</td><td>The day you want to list the transactions for<br><br><strong>Format:</strong> yyyy-MM-dd<br><strong>Rule:</strong> The same day and future dates cannot be provided.</td></tr></tbody></table>

**Parameters Returned from the Service**

<table><thead><tr><th width="268">Parameter</th><th width="183.33333333333331">Type</th><th>Description</th></tr></thead><tbody><tr><td>Id</td><td>int</td><td>Payment ID</td></tr><tr><td>PosType</td><td>int</td><td>Virtual POS type where the transaction occurred<br><br>See: <a href="broken-reference">Virtual POS Types </a></td></tr><tr><td>RegionId</td><td>int</td><td>Country information where the transaction occurred<br><br>See: <a href="broken-reference">Countries</a></td></tr><tr><td>UniqueCode</td><td>Guid</td><td>Tracking code assigned by Paywall to the transaction</td></tr><tr><td>MerchantUniqueCode</td><td>string</td><td>Unique tracking code provided by you at the time of payment initiation</td></tr><tr><td>TrackingCode</td><td>string</td><td>Tracking code provided by you at the time of payment initiation</td></tr><tr><td>Amount</td><td>decimal</td><td>Amount information</td></tr><tr><td>MethodId</td><td>short</td><td>Transaction method<br><br>See: <a href="broken-reference">Methods</a></td></tr><tr><td>TypeId</td><td>short</td><td>Transaction type<br><br>See: <a href="broken-reference">Types </a></td></tr><tr><td>StatusId</td><td>short</td><td>Transaction status<br><br>See: <a href="broken-reference">Statuses</a></td></tr><tr><td>Installment</td><td>byte</td><td>Installment information of the transaction</td></tr><tr><td>ChannelId</td><td>short</td><td>Transaction channel information<br><br>See: <a href="broken-reference">Channels</a></td></tr><tr><td>TagId</td><td>int</td><td>The tracking number you assigned to the transaction</td></tr><tr><td>Ip</td><td>string</td><td>The IP address from which the transaction was sent to Paywall</td></tr><tr><td>ClientIp</td><td>string</td><td>The client IP address where the transaction was performed</td></tr><tr><td>InsertDateTime</td><td>DateTime</td><td>The date and time when the transaction occurred</td></tr><tr><td>Card > Owner</td><td>string</td><td>The date and time when the transaction occurred</td></tr><tr><td>Card > Number</td><td>string</td><td>Information on the card used for the transaction</td></tr><tr><td>Commission > Exists</td><td>bool</td><td>Masked form of the card number used in the transaction</td></tr><tr><td>Commission > Commission</td><td>decimal?</td><td>Was a commission identified for the payment?</td></tr><tr><td>Commission > AppliedInterest</td><td>bool</td><td>Identified commission information</td></tr><tr><td>Commission > Interest</td><td>decimal?</td><td>Was a term applied to the payment?</td></tr><tr><td>Commission > OriginalAmount</td><td>decimal</td><td>The term rate applied to the payment</td></tr><tr><td>Commission > InterestAmount</td><td>decimal?</td><td>Original amount information of the payment</td></tr><tr><td>PaymentGateway > PaymentGatewayId</td><td>int</td><td>Termed amount of the payment</td></tr><tr><td>PaymentGateway > PaymentGatewayName</td><td>string</td><td>Virtual POS connection ID where the transaction was performed</td></tr><tr><td>PaymentGateway > PaymentGatewayProviderName</td><td>string</td><td>Name assigned to the Virtual POS connection where the transaction was performed</td></tr></tbody></table>

{% tabs %}
{% tab title="Json" %}
{% code lineNumbers="true" %}

```json
{
    "ErrorCodeType": 1,
    "ErrorMessage": "",
    "ErrorCode": 0,
    "Result": true,
    "Message": "",
    "Body": {
        "SortType": "asc",
        "Page": 1,
        "PageSize": 10,
        "TotalRecords": 29388,
        "Data": [
            {
                "Id": 4013828,
                "PosType": 1,
                "RegionId": null,
                "UniqueCode": "187d18f1-fdca-48e1-87b8-6801f3b8703e",
                "MerchantUniqueCode": "f29926b8-8870-442f-8089-a5eadaaf139a",
                "TrackingCode": null,
                "Amount": 5.00,
                "MethodId": 2,
                "TypeId": 1,
                "StatusId": 5,
                "Installment": 1,
                "ChannelId": null,
                "TagId": null,
                "Ip": "212.125.11.139",
                "ClientIp": null,
                "InsertDateTime": "2025-05-27T10:22:38.7375463",
                "Card": {
                    "Owner": "Sipay Karti",
                    "Number": "979208******4513"
                },
                "Commission": {
                    "Exists": true,
                    "Commission": 0.00,
                    "AppliedInterest": false,
                    "Interest": 0.00,
                    "OriginalAmount": 5.00,
                    "InterestAmount": 0.00
                },
                "PaymentGateway": {
                    "PaymentGatewayId": 4202,
                    "PaymentGatewayName": "İşbank",
                    "PaymentGatewayProviderName": "İşbank"
                }
            },
            {
                "Id": 4013820,
                "PosType": 1,
                "RegionId": null,
                "UniqueCode": "28bb313d-cfd2-4f76-8115-3b1121bf3a85",
                "MerchantUniqueCode": "74a77019-f965-40b1-95d6-2d5521dad2da",
                "TrackingCode": null,
                "Amount": 5.00,
                "MethodId": 2,
                "TypeId": 1,
                "StatusId": 5,
                "Installment": 1,
                "ChannelId": null,
                "TagId": null,
                "Ip": "212.125.11.139",
                "ClientIp": null,
                "InsertDateTime": "2025-05-27T10:22:38.9554829",
                "Card": {
                    "Owner": "Sipay Karti",
                    "Number": "979208******4513"
                },
                "Commission": {
                    "Exists": true,
                    "Commission": 0.00,
                    "AppliedInterest": false,
                    "Interest": 0.00,
                    "OriginalAmount": 5.00,
                    "InterestAmount": 0.00
                },
                "PaymentGateway": {
                    "PaymentGatewayId": 4202,
                    "PaymentGatewayName": "İşbank",
                    "PaymentGatewayProviderName": "İşbank"
                }
            },
            {
                "Id": 4013821,
                "PosType": 1,
                "RegionId": null,
                "UniqueCode": "51d9d26f-8d40-40b1-87b7-acdd987220e4",
                "MerchantUniqueCode": "0bccc6c8-40de-4135-a6be-aee173ceff23",
                "TrackingCode": null,
                "Amount": 5.00,
                "MethodId": 2,
                "TypeId": 1,
                "StatusId": 5,
                "Installment": 1,
                "ChannelId": null,
                "TagId": null,
                "Ip": "212.125.11.139",
                "ClientIp": null,
                "InsertDateTime": "2025-05-27T10:22:39.0463645",
                "Card": {
                    "Owner": "Sipay Karti",
                    "Number": "979208******4513"
                },
                "Commission": {
                    "Exists": true,
                    "Commission": 0.00,
                    "AppliedInterest": false,
                    "Interest": 0.00,
                    "OriginalAmount": 5.00,
                    "InterestAmount": 0.00
                },
                "PaymentGateway": {
                    "PaymentGatewayId": 4202,
                    "PaymentGatewayName": "İşbank",
                    "PaymentGatewayProviderName": "İşbank"
                }
            },
            {
                "Id": 4013822,
                "PosType": 1,
                "RegionId": null,
                "UniqueCode": "3c61b9d3-0a6c-4dbb-999a-f70b6a356a14",
                "MerchantUniqueCode": "2faa9147-13ca-4420-b35b-ce4131b56439",
                "TrackingCode": null,
                "Amount": 5.00,
                "MethodId": 2,
                "TypeId": 1,
                "StatusId": 5,
                "Installment": 1,
                "ChannelId": null,
                "TagId": null,
                "Ip": "212.125.11.139",
                "ClientIp": null,
                "InsertDateTime": "2025-05-27T10:22:39.340993",
                "Card": {
                    "Owner": "Sipay Karti",
                    "Number": "979208******4513"
                },
                "Commission": {
                    "Exists": true,
                    "Commission": 0.00,
                    "AppliedInterest": false,
                    "Interest": 0.00,
                    "OriginalAmount": 5.00,
                    "InterestAmount": 0.00
                },
                "PaymentGateway": {
                    "PaymentGatewayId": 4202,
                    "PaymentGatewayName": "İşbank",
                    "PaymentGatewayProviderName": "İşbank"
                }
            },
            {
                "Id": 4013824,
                "PosType": 1,
                "RegionId": null,
                "UniqueCode": "7663cc19-0065-49f7-9f16-85abd3f1cfb1",
                "MerchantUniqueCode": "431d2994-53ff-48cf-8528-ab37d41988f4",
                "TrackingCode": null,
                "Amount": 5.00,
                "MethodId": 2,
                "TypeId": 1,
                "StatusId": 5,
                "Installment": 1,
                "ChannelId": null,
                "TagId": null,
                "Ip": "212.125.11.139",
                "ClientIp": null,
                "InsertDateTime": "2025-05-27T10:22:39.489455",
                "Card": {
                    "Owner": "Sipay Karti",
                    "Number": "979208******4513"
                },
                "Commission": {
                    "Exists": true,
                    "Commission": 0.00,
                    "AppliedInterest": false,
                    "Interest": 0.00,
                    "OriginalAmount": 5.00,
                    "InterestAmount": 0.00
                },
                "PaymentGateway": {
                    "PaymentGatewayId": 4202,
                    "PaymentGatewayName": "İşbank",
                    "PaymentGatewayProviderName": "İşbank"
                }
            },
            {
                "Id": 4013823,
                "PosType": 1,
                "RegionId": null,
                "UniqueCode": "0286312c-3cde-4bb2-87db-6d3838043976",
                "MerchantUniqueCode": "fb74f3d1-492c-463c-ae35-bf27d4efc420",
                "TrackingCode": null,
                "Amount": 5.00,
                "MethodId": 2,
                "TypeId": 1,
                "StatusId": 5,
                "Installment": 1,
                "ChannelId": null,
                "TagId": null,
                "Ip": "212.125.11.139",
                "ClientIp": null,
                "InsertDateTime": "2025-05-27T10:22:39.4894552",
                "Card": {
                    "Owner": "Sipay Karti",
                    "Number": "979208******4513"
                },
                "Commission": {
                    "Exists": true,
                    "Commission": 0.00,
                    "AppliedInterest": false,
                    "Interest": 0.00,
                    "OriginalAmount": 5.00,
                    "InterestAmount": 0.00
                },
                "PaymentGateway": {
                    "PaymentGatewayId": 4202,
                    "PaymentGatewayName": "İşbank",
                    "PaymentGatewayProviderName": "İşbank"
                }
            },
            {
                "Id": 4013829,
                "PosType": 1,
                "RegionId": null,
                "UniqueCode": "4b1a49db-a672-4c0d-a102-ab6861921b5f",
                "MerchantUniqueCode": "7d33c6c4-9407-436e-b9e9-ab6f67f18c2d",
                "TrackingCode": null,
                "Amount": 5.00,
                "MethodId": 2,
                "TypeId": 1,
                "StatusId": 5,
                "Installment": 1,
                "ChannelId": null,
                "TagId": null,
                "Ip": "212.125.11.139",
                "ClientIp": null,
                "InsertDateTime": "2025-05-27T10:22:39.8333401",
                "Card": {
                    "Owner": "Sipay Karti",
                    "Number": "979208******4513"
                },
                "Commission": {
                    "Exists": true,
                    "Commission": 0.00,
                    "AppliedInterest": false,
                    "Interest": 0.00,
                    "OriginalAmount": 5.00,
                    "InterestAmount": 0.00
                },
                "PaymentGateway": {
                    "PaymentGatewayId": 4202,
                    "PaymentGatewayName": "İşbank",
                    "PaymentGatewayProviderName": "İşbank"
                }
            },
            {
                "Id": 4013825,
                "PosType": 1,
                "RegionId": null,
                "UniqueCode": "3b052eb7-8cc4-4a59-9d77-e2e312a3a9c4",
                "MerchantUniqueCode": "c81ee635-7151-4717-aad2-6a3fd0ffe5fa",
                "TrackingCode": null,
                "Amount": 5.00,
                "MethodId": 2,
                "TypeId": 1,
                "StatusId": 5,
                "Installment": 1,
                "ChannelId": null,
                "TagId": null,
                "Ip": "212.125.11.139",
                "ClientIp": null,
                "InsertDateTime": "2025-05-27T10:22:40.762465",
                "Card": {
                    "Owner": "Sipay Karti",
                    "Number": "979208******4513"
                },
                "Commission": {
                    "Exists": true,
                    "Commission": 0.00,
                    "AppliedInterest": false,
                    "Interest": 0.00,
                    "OriginalAmount": 5.00,
                    "InterestAmount": 0.00
                },
                "PaymentGateway": {
                    "PaymentGatewayId": 4202,
                    "PaymentGatewayName": "İşbank",
                    "PaymentGatewayProviderName": "İşbank"
                }
            },
            {
                "Id": 4013826,
                "PosType": 1,
                "RegionId": null,
                "UniqueCode": "086a3406-f3ba-4268-819c-627922cfd8e7",
                "MerchantUniqueCode": "9ebd5715-02a4-45b0-9704-38ebfba9d9fa",
                "TrackingCode": null,
                "Amount": 5.00,
                "MethodId": 2,
                "TypeId": 1,
                "StatusId": 5,
                "Installment": 1,
                "ChannelId": null,
                "TagId": null,
                "Ip": "212.125.11.139",
                "ClientIp": null,
                "InsertDateTime": "2025-05-27T10:22:40.9346009",
                "Card": {
                    "Owner": "Sipay Karti",
                    "Number": "979208******4513"
                },
                "Commission": {
                    "Exists": true,
                    "Commission": 0.00,
                    "AppliedInterest": false,
                    "Interest": 0.00,
                    "OriginalAmount": 5.00,
                    "InterestAmount": 0.00
                },
                "PaymentGateway": {
                    "PaymentGatewayId": 4202,
                    "PaymentGatewayName": "İşbank",
                    "PaymentGatewayProviderName": "İşbank"
                }
            },
            {
                "Id": 4013827,
                "PosType": 1,
                "RegionId": null,
                "UniqueCode": "5ea58971-4db0-41c6-99ba-cca93f5e7824",
                "MerchantUniqueCode": "1c50dce9-ac1d-4ab5-9e8b-5350a4ddf868",
                "TrackingCode": null,
                "Amount": 5.00,
                "MethodId": 2,
                "TypeId": 1,
                "StatusId": 5,
                "Installment": 1,
                "ChannelId": null,
                "TagId": null,
                "Ip": "212.125.11.139",
                "ClientIp": null,
                "InsertDateTime": "2025-05-27T10:22:41.2579889",
                "Card": {
                    "Owner": "Sipay Karti",
                    "Number": "979208******4513"
                },
                "Commission": {
                    "Exists": true,
                    "Commission": 0.00,
                    "AppliedInterest": false,
                    "Interest": 0.00,
                    "OriginalAmount": 5.00,
                    "InterestAmount": 0.00
                },
                "PaymentGateway": {
                    "PaymentGatewayId": 4202,
                    "PaymentGatewayName": "İşbank",
                    "PaymentGatewayProviderName": "İşbank"
                }
            }
        ],
        "HasPreviousPage": false,
        "HasNextPage": true
    }
}
```

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