4. Query

You can use this service to query your sales orders on your terminals.

GET {{Base Address}}/api/payment/inquiry/{paymentRequestId}

It will be sufficient to send a request to the address provided above. You can use the 'Base Address' as desired for both the test environment and the production environment.

Important: In order to use the Payment Query service, you need to send the 'apikeyprivate' and 'apiclientprivate' parameters in the 'Header' field.

PhysicalAPI Address

The header information that needs to be sent to the service is as follows:

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.

Response returned from the service:

Parameter	Type	Description
Result	object	Returns the information in the details of the service.
ErrorCode	int	Error code. Returns the value '0' if the transaction is successful.
Succeeded	bool	Returns a true or false value. Returns 'true' if the transaction is successful.
Failed	bool	It returns either a true or false value. If the operation fails, it returns 'true'
Message	string	This is the specified message for the error if the operation fails, providing language support based on the locale parameter.
ClientMessage	string	It returns constant values for Paywall error codes. You can perform mapping.

JSON

{
    "Result": {
        "PaymentRequestId": "1eb856a8-1d41-49ab-8994-ecee2880d62c",
        "PaymentRequestActivityId": "78e71139-2227-48ee-9bf9-1e4389a399db",
        "TerminalId": "38e895c3-1a9a-4b73-8816-8557d1d031d6",
        "MerchantUniqueCode": "432e795d-1a69-4461-97c8-ebaab658ff47",
        "DisplayCode": "İndirimli Hizmet",
        "CallbackAddress": "https://webhook.site/445d7d94-962b-4350-a936-1a066c6367b3",
        "Amount": 1.44,
        "PaymentChannelId": 1,
        "PaymentChannel": "Async",
        "CurrencyId": 1,
        "Currency": "TRY",
        "IP": "::1",
        "PaymentTypeId": 1,
        "PaymentType": "Sale",
        "PaymentStatusId": 2,
        "PaymentStatus": "SentToDevice",
        "CreatedDate": "2024-09-02T13:52:34.504179",
        "ModifiedDate": null
    },
    "Failed": false,
    "Message": null,
    "ClientMessage": null,
    "Succeeded": true
}