1. Customer Transaction Number

You can query the payment using the MerchantUniqueCode parameter. MerchantUniqueCode is the unique payment tracking number provided by you at the time of initiating the payment.

Payment Query (MerchantUniqueCode)

GET {{Private Base Address}}/api/paywall/private/query

Important: To use the Payment Query service, you must include the apikeyprivate and apiclientprivate parameters in the Header. PaymentPrivateAPI Address

Parameter	Type	Compulsory	Description
apikeyprivate	string	Yes	Public Key obtained from the merchant panel.
apiclientprivate	string	Yes	Public Client obtained from the merchant panel.
merchantuniquecode	string	Yes	Unique tracking code assigned by you for the payment.

Sample Code:

C#

using System;
using System.Net.Http;
using System.Threading.Tasks;
using Newtonsoft.Json;

public class Program
{
    private static readonly HttpClient client = new HttpClient();

    private static async Task Main()
    {
        client.DefaultRequestHeaders.Add("apikeyprivate", "%PRIVATEKEY%");
        client.DefaultRequestHeaders.Add("apiclientprivate", "%PRIVATECLIENT%");
        client.DefaultRequestHeaders.Add("merchantuniquecode", "%MerchantUniqueCode%");
        var response = await client.GetAsync("{{Private Base Address}}/api/paywall/private/query");
        var responseString = await response.Content.ReadAsStringAsync();
        var responseObject = JsonConvert.DeserializeObject<Response>(responseString);
        Console.WriteLine(responseObject.Body.Paywall.StatusName);
    }

    public class Response
    {
        public int ErrorCode { get; set; }
        public bool Result { get; set; }
        public string Message { get; set; }
        public Body Body { get; set; }
    }

    public class Body
    {
        public Paywall Paywall { get; set; }
    }

    public class Paywall
    {
        public int PaymentId { get; set; }
        public int ActivityId { get; set; }
        public bool Status { get; set; }
        public string StatusName { get; set; }
        // Define other properties as needed...
    }
}

Parameter Descriptions:

Parameter	Type	Descriptions
PaymentId	int	Payment identifier
UniqueCode	Guid	Unique tracking number generated by Paywall for the payment
MerchantUniqueCode	string	Unique tracking number provided by the merchant at the time of payment initiation
TrackingCode	string	Tracking number provided by the merchant at the time of payment initiation
ActivityId	int	Identifier of the last payment activity
PaymentGatewayId	int	Identifier of the payment gateway through which the transaction was processed
PaymentGatewayName	string	Name of the payment gateway through which the transaction was processed
PaymentGatewayProviderName	string	Provider name of the payment gateway in the system
IsThreeDSecure	bool	Is the transaction 3D secure?
IsNonThreeDSecure	bool	Is the transaction Non-3D secure?
IsInsuranceSecure	bool	Is the transaction secured with insurance (first 8 and last 4 digits)?
IsProvision	bool	Is the transaction pre-authorized (provisioned)?
IsOtp	bool	Is the transaction performed using OTP method?
AnySuccessPayment	bool	Is there any successful sale within the transaction scope?
AnySuccessRefund	bool	Is there any successful refund within the transaction scope?
AnySuccessPartialRefund	bool	Is there any successful partial refund within the transaction scope?
AnySuccessCancel	bool	Is there any successful cancellation within the transaction scope?
Status	boolean	Status of the last activity, true: successful / false: failed
StatusName	string	Payment status
StatusId	int	Payment status identifier
TypeName	string	Type of the last payment activity
TypeId	int	Identifier of the last payment activity type
Installment	int	Installment information
CurrencyId	int	Payment currency identifier
CurrencyName	string	Payment currency
PaymentMethodId	int	Payment method identifier See: Payment Methods
PaymentMethodName	string	Payment method
PaymentChannelId	int	Payment channel identifier See: Payment Channels
PaymentChannelName	string	Payment channel
PaymentTagId	int	Payment tag identifier
PaymentTagName	string	Payment tag
CardNumber	string	Masked card number
CardOwnerName	string	Masked cardholder name
CardBankId	int	Identifier of the card's bank
CardBankName	string	Name of the card's bank
CardBrandId	int	Identifier of the card brand
CardBrandName	string	Name of the card brand
CardTypeId	int	Identifier of the card type
CardTypeName	string	Name of the card type
CardFamilyId	int	Identifier of the card family
CardFamilyName	string	Name of the card family
LastActivityDateTime	DateTime	Date and time of the last transaction related to the payment
PaymentAmount	decimal	Total payment amount
ActivityAmount	decimal	Last transaction amount Example: If a transaction with a total amount of 1000 TL has a partial refund of 100 TL, this parameter will return 100.
IP	string	IP address to which the transaction was sent
ClientIP	string	IP address of the device used to initiate the payment
AppliedInterest	bool	Was an installment interest applied to the payment?
InterestRate	decimal?	Applied interest rate
CommissionRate	decimal?	Commission applied by the payment provider Returns the value you configured in the Paywall panel.
OriginalAmount	decimal	Original payment amount Example: If the payment is 1000 TL and after applying a 100 TL installment interest the charged amount becomes 1100 TL, this parameter will return 1000 TL as the original amount before interest was applied.
InterestAmount	decimal?	If applicable, the applied installment interest amount
CommissionAmount	decimal	Commission amount applied to the payment by the payment institution/bank
UsedSavedCard	bool	Was the payment made using a saved card?
UsedTempCard	bool	Was the payment made using a client-side tokenized card?
Activities	List	All actions related to the transaction (Created, Sale Started, Sale Failed, Cancellation Successful, etc.)
IsFullyRefunded	bool	Information on whether the transaction has been fully canceled/refunded.
RemainingRefundAmount	decimal	Total refundable amount. This amount decreases as partial refunds are made.

JSON

{
    "ErrorCodeType": 1,
    "ErrorMessage": null,
    "ErrorCode": 0,
    "Result": true,
    "Message": "",
    "Body": {
        "Paywall": {
            "PaymentId": 4045713,
            "UniqueCode": "cdd14b16-74fd-4f3b-863f-fccb3ec80baf",
            "MerchantUniqueCode": "5b0287fb-0ccc-4366-9b2a-048be739e54c",
            "TrackingCode": "123123912831092831092-34534535-3453454",
            "ActivityId": 8907375,
            "PaymentGatewayId": 1570,
            "PaymentGatewayName": "ProviderConnectionName",
            "PaymentGatewayProviderName": "ProviderSystemName",
            "IsThreeDSecure": false,
            "IsNonThreeDSecure": true,
            "IsInsuranceSecure": false,
            "IsProvision": true,
            "IsOtp": false,
            "AnySuccessPayment": false,
            "AnySuccessRefund": false,
            "AnySuccessPartialRefund": false,
            "AnySuccessCancel": false,
            "Error": {
                "AnyError": false,
                "ErrorType": 0,
                "ErrorMessage": ""
            },
            "Status": false,
            "StatusName": "Finansallaştırma Bekliyor",
            "StatusId": 3,
            "TypeName": "Satış",
            "TypeId": 1,
            "Installment": 1,
            "CurrencyId": 1,
            "CurrencyName": "TRY",
            "PaymentMethodId": 4,
            "PaymentMethodName": "Half Direct Payment",
            "PaymentChannelId": 0,
            "PaymentChannelName": null,
            "PaymentTagId": 0,
            "PaymentTagName": null,
            "CardNumber": "552879******0008",
            "CardOwnerName": "Enes Selman Tütüncü",
            "CardBankId": 55,
            "CardBankName": "T.HALK BANKASI A.Ş.",
            "CardBrandId": 1,
            "CardBrandName": "Master Card",
            "CardTypeId": 1,
            "CardTypeName": "Credit",
            "CardFamilyId": 5,
            "CardFamilyName": "Paraf",
            "LastActivityDateTime": "2025-06-04T18:42:27.5447456",
            "PaymentAmount": 1000.00,
            "ActivityAmount": 1000.00,
            "IP": "35.245.18.66",
            "ClientIP": null,
            "AppliedInterest": false,
            "InterestRate": 0.00,
            "CommissionRate": 0.00,
            "OriginalAmount": 1000.00,
            "InterestAmount": 0.00,
            "CommissionAmount": 0.00,
            "UsedSavedCard": true,
            "UsedTempCard": false
        }
    }
}