4. Query
This service allows you to query information related to a specific payment transaction. You can use this service to check the payment status, amount, and other details.
Payment Query Service
GET {{Base Adres}}/api/paywall/payment/bulk/payment/query
Important: To use the payment query service, you must include the parameters apikeypublic and apiclientpublic in the Header section.
The parameters that must be sent to the service are as follows:
apikeypublic
string
Yes
The Public Key you obtained from the merchant panel.
apiclientpublic
string
Yes
The Public Client you obtained from the merchant panel.
merchantuniquecode
string
Yes
A unique identifier code specific to the merchant. It is sent to Paywall as a parameter when initiating the transaction.
pageSize
int
Yes
Number of transactions to be listed
Max: 1000
geNumber
int
Yes
Page number
Response Returned from the Service > Root Directory
Result
bool
Indicates whether the transaction has been successfully received and accepted by Paywall. A true value does not mean the payments are completed successfully; it means they have been successfully received for processing. Payment results will be delivered via callback.
TotalPaymentCount
int
Total number of transactions
TotalPaymentAmount
decimal
Total transaction amount
TotalSuccessPaymentCount
int
Total number of successful transactions
TotalSuccessPaymentAmount
decimal
Total amount of successful transactions
TotalUnsuccessfulPaymentCount
int
Total number of failed transactions
TotalUnsuccessfulPaymentAmount
decimal
Total amount of failed transactions
TotalUnprocessedPaymentCount
int
Number of transactions that could not be processed due to possible disaster scenarios
TotalUnprocessedPaymentAmount
decimal
Amount of transactions that could not be processed due to possible disaster scenarios
PageNumber
int
Requested page number
PageSize
int
Number of transactions requested to be listed
TotalPages
int
Total number of pages
Payments
List<Payment>
Contains the details of each transaction Note: If individual transactions need to be refunded/cancelled, you must store the MerchantUniqueCode parameter for each payment on your side.
Response Returned from the Service > Root Directory Payments
MerchantUniqueCode
string
Automatically assigned by Paywall for each transaction. If individual transactions need to be handled (e.g., cancellation, refund), this should be stored.
PaymentId
int
This is the transaction's ID within the Paywall system.
Amount
decimal
The amount of the transaction.
Status
int
The status information of the transaction. Payment Status
Scope
int
The scope of the transaction (Sale, Cancellation, Refund).
Payment Types
Example JSON Returned from the Service
Last updated