2. Query Payment

You can use this service to query the status of a payment made through APM, and get the latest status and details of the payment.

Query Payment

GET {{Base Adres}}/api/paywall/apm/query

Important: To use the APM Payment Query service, you need to include 'apikeypublic' and 'apiclientpublic' parameters in the 'Header' field.

PaymentAPI Address

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

Parameter (Headers)	Type	Compulsory	Description
apikeypublic	string	Yes	The Public Key obtained from the merchant panel.
apiclientpublic	string	Yes	The Public Client obtained from the merchant panel.
merchantuniquecode	string	Yes	The unique tracking number assigned to the payment initiation.

The parameters returned from the service are as follows:

Parameter	Type	Description
ApmConnectionId	int	The APM connection identifier where the payment was processed.
ApmProviderKey	string	The APM provider key where the payment was processed.
ApmTransactionId	int	The identity information of the payment in PayWall.
CurrencyId	int	The identity information of the currency for the payment. Bkz: Currency
MerchantUniqueCode	string	The unique tracking number for the payment.
UniqueCode	string	The unique number assigned to the payment by Paywall.
MerchantSuccessBackUrl	string	The address to be notified in case of successful payment completion.
MerchantFailBackUrl	string	The address to be notified in case of unsuccessful payment completion.
Amount	decimal	The payment amount.
Description	string	The description of the payment.
ChannelType	int	The payment channel type. Bkz: APM Channel Type
StatusId	int	The payment status identifier. Bkz: APM Status Id
Status	string	The payment status.
TypeId	int	The payment type identifier. Bkz: APM Type Id
Type	string	The payment type.
Ip	string	The IP address from which the payment was initiated.
DateTime	DateTime	The date/time when the payment was initiated.

JSON

{
    "ErrorCode": 0,
    "Result": true,
    "Message": "",
    "Body": {
        "ApmConnectionId": 1,
        "ApmProviderKey": "Papara",
        "ApmTransactionId": 31,
        "CurrencyId": 1,
        "MerchantUniqueCode": "TESTMERCaHANTUNssIQUECODE",
        "UniqueCode": "eed41239-84a2-4ae6-8927-f9aa4ccee94f",
        "MerchantSuccessBackUrl": "https://webhook.site/38a6fa6f-3414-40db-b2a7-a6c38894b6a3",
        "MerchantFailBackUrl": "https://webhook.site/38a6fa6f-3414-40db-b2a7-a6c38894b6a3",
        "Amount": 1.00,
        "Description": "test",
        "ChannelType": 1,
        "StatusId": 1,
        "Status": "Oluşturuldu",
        "TypeId": 1,
        "Type": "Satış",
        "Ip": "::1",
        "DateTime": "2023-09-04T14:47:03.485303"
    }
}