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.

PaymentAPI Address

The parameters that must be sent to the service are as follows:

Parameter	Type	Compolsory	Description
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.

Response Returned from the Service > Root Directory

Parameter	Type	Description
Result	bool	Indicates whether the transaction was successfully received by Paywall. A successful (true) response means that the payments have been accepted for processing, not that they have been completed successfully. Payment results will be delivered via callback notifications.
TotalPaymentCount	int	Indicates the number of transactions that have been received.
Payments	List<Payment>	Contains the details of each individual transaction. Note: If transactions are to be refunded or canceled individually, you must store each payment’s MerchantUniqueCode on your side.

Response Returned from the Service > Root Directory Payments

Parameter	Type	Description
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

JSON

{
    "Result": true,
    "TotalPaymentCount": 6,
    "Payments": [
        {
            "MerchantUniqueCode": "a4d6a8f3-ae0b-4a7a-a891-fef072057774",
            "PaymentId": 2094937,
            "Amount": 1.59,
            "Status": 4,
            "Scope": 3,
            "ErrorMessage": null
        },
        {
            "MerchantUniqueCode": "7ce4076f-34a3-473b-9755-33db643ee7da",
            "PaymentId": 2094938,
            "Amount": 1.59,
            "Status": 4,
            "Scope": 3,
            "ErrorMessage": null
        },
        {
            "MerchantUniqueCode": "bf48c65f-a452-4425-bc3a-cd018c7fadc7",
            "PaymentId": 2094939,
            "Amount": 1.59,
            "Status": 4,
            "Scope": 3,
            "ErrorMessage": null
        },
        {
            "MerchantUniqueCode": "80375fee-7bdd-4d46-8ad9-a66f68692443",
            "PaymentId": 2094940,
            "Amount": 1.59,
            "Status": 4,
            "Scope": 3,
            "ErrorMessage": null
        },
        {
            "MerchantUniqueCode": "7e608239-bf32-44f4-8ff8-e684583a9f51",
            "PaymentId": 2094941,
            "Amount": 1.59,
            "Status": 4,
            "Scope": 3,
            "ErrorMessage": null
        },
        {
            "MerchantUniqueCode": "c99880ff-4035-4eb9-a6fa-6f6756636c4b",
            "PaymentId": 2094942,
            "Amount": 1.59,
            "Status": 4,
            "Scope": 3,
            "ErrorMessage": null
        }
    ]
}