The payment listing service returns all transactions for a specific day using a pagination mechanism.
Transaction-Based
GET{{Private Base Address}}/api/paywall/private/vpos/transaction/list/activity
Important: To use the Payment Listing – Transaction-Based service, you must include the apikeyprivate and apiclientprivate parameters in the Header.ir.
PaymentPrivateAPI Address
The Payment Listing – Transaction-Based service lists only the completed transactions of the most recent T-1 day. Transactions that have not been completed by the end of the day are not included in this service.
In this service, the 🗓️ date parameter operates based on the dates of transaction steps (sale, cancellation, refund, partial refund) during filtering.
Sent Header Information:
Parameter
Type
Compulsory
Description
apikeyprivate
string
Yes
The Private Key obtained from the merchant panel.
apiclientprivate
string
Yes
The Private Client obtained from the merchant panel.
page
int
Yes
Number of pages to be listed
Min: 1
pageSize
int
Yes
Number of items per page to be listed
Maks: 1000
date
DateTime
Yes
The date for which you want to list transactions
Format: yyyy-MM-dd
Rule: The same day or a future date cannot be provided.
onlySuccess
bool
No
If sent as TRUE, only the successful steps (Activities | Sale, Cancellation, Refund, etc.) of the related transaction will be returned.
onlyDateSensitiveActivity
bool
No
If sent as TRUE, only the steps of the transaction that match the date specified in the date parameter will be returned; steps from other dates will not be included.
Parameters Returned from the Service
Parameter
Type
Description
Id
int
Payment ID
PosType
int
Virtual POS type used for the transactioni
See: Virtual POS Types
RegionId
int
Country where the transaction took place
See: Countries
UniqueCode
Guid
Tracking code assigned to the transaction by Paywall
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: Statues
Installment
byte
Installment information of the transaction
ChannelId
short
Transaction channel information
See: Channels
TagId
int
Tracking number assigned by you to the transaction
Ip
string
IP address from which the transaction was sent to Paywall
ClientIp
string
Client IP address from which the transaction was performed
InsertDateTime
DateTime
Transaction date and time information
Card > Owner
string
Card information used in the transaction
Card > Number
string
Masked card number used in the transaction
Commission > Exists
bool
Indicates whether any commission information has been identified for the payment
Commission > Commission
decimal?
Detected commission information
Commission > AppliedInterest
bool
Indicates whether maturity was applied to the payment
Commission > Interest
decimal?
Maturity rate applied to the payment
Commission > OriginalAmount
decimal
Original amount of the payment
Commission > InterestAmount
decimal?
Deferred (maturity-applied) amount of the payment
PaymentGateway > PaymentGatewayId
int
Virtual POS connection ID used for the transaction
PaymentGateway > PaymentGatewayName
string
Name assigned to the Virtual POS connection used for the transaction
PaymentGateway > PaymentGatewayProviderName
string
System name of the Virtual POS provider in Paywall used for the transaction
