20. Payment Listing

The payment listing service returns a paginated list of all transactions performed on a specific day.

Payment Listing

GET {{Private Base Address}}/api/paywall/private/vpos/transaction/list

Important: To use the Payment Listing service, you must include the parameters apikeyprivate and apiclientprivate in the Header section. PaymentPrivateAPI Address

Sent Headers Information:

Parameter
Type
Compolsory
Description

apikeyprivate

string

Yes

Public Key you obtained from the merchant panel.

apiclientprivate

string

Yes

Public Client you obtained from the merchant panel.

page

int

Yes

Page number you want to list Min: 1

pageSize

int

Yes

Number of items per page you want to list Maks: 1000

date

DateTime

Yes

The day you want to list the transactions for Format: yyyy-MM-dd Rule: The same day and future dates cannot be provided.

Parameters Returned from the Service

Parameter
Type
Description

Id

int

Payment ID

PosType

int

Virtual POS type where the transaction occurred See: Virtual POS Types

RegionId

int

Country information where the transaction occurred See: Countries

UniqueCode

Guid

Tracking code assigned by Paywall to the transaction

MerchantUniqueCode

string

Unique tracking code provided by you at the time of payment initiation

TrackingCode

string

Tracking code provided by you at the time of payment initiation

Amount

decimal

Amount information

MethodId

short

Transaction method See: Methods

TypeId

short

Transaction type See: Types

StatusId

short

Transaction status See: Statuses

Installment

byte

Installment information of the transaction

ChannelId

short

Transaction channel information See: Channels

TagId

int

The tracking number you assigned to the transaction

Ip

string

The IP address from which the transaction was sent to Paywall

ClientIp

string

The client IP address where the transaction was performed

InsertDateTime

DateTime

The date and time when the transaction occurred

Card > Owner

string

The date and time when the transaction occurred

Card > Number

string

Information on the card used for the transaction

Commission > Exists

bool

Masked form of the card number used in the transaction

Commission > Commission

decimal?

Was a commission identified for the payment?

Commission > AppliedInterest

bool

Identified commission information

Commission > Interest

decimal?

Was a term applied to the payment?

Commission > OriginalAmount

decimal

The term rate applied to the payment

Commission > InterestAmount

decimal?

Original amount information of the payment

PaymentGateway > PaymentGatewayId

int

Termed amount of the payment

PaymentGateway > PaymentGatewayName

string

Virtual POS connection ID where the transaction was performed

PaymentGateway > PaymentGatewayProviderName

string

Name assigned to the Virtual POS connection where the transaction was performed

{
    "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
    }
}

Last updated