> For the complete documentation index, see [llms.txt](https://developer.paywall.one/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developer.paywall.one/payment-orchestration-integration-document/payment-service/13.-payment-inquiry/4.-product-identifier.md).

# 4. Product Identifier

## **Payment Query (ProductId)**

<mark style="color:blue;">`GET`</mark> `{{Private Base Address}}/api/paywall/private/query/by/productid`

{% hint style="info" %}
**Important:** To use the Payment Query (by Product Information) service, you must include the **apikeyprivate** and **apiclientprivate** parameters in the **Header** section.\
\
[<mark style="color:green;">**PaymentPrivateAPI Address**</mark>](/payment-orchestration-integration-document/environment.md)
{% endhint %}

{% hint style="warning" %}
**The payment query service using product identifier returns a maximum of 100 records.**
{% endhint %}

**Required headers and request parameters:**

<details>

<summary>Parameters and Descriptions</summary>

<table><thead><tr><th width="215.83203125">Parameter</th><th width="126.7890625">Type</th><th width="168.6484375">Compulsory</th><th width="403">Description</th></tr></thead><tbody><tr><td>apikeyprivate</td><td>string</td><td>Yes</td><td>Public Key obtained from the merchant panel.</td></tr><tr><td>apiclientprivate</td><td>string</td><td>Yes</td><td>Public Client obtained from the merchant panel.</td></tr><tr><td>merchantuniquecode</td><td>string </td><td>Optional</td><td>Unique tracking code assigned by you for the payment.</td></tr><tr><td>productid</td><td>string</td><td>Yes</td><td>The information provided by you in the ProductId parameter related to the payment.</td></tr></tbody></table>

</details>

**Example Code:**

{% tabs %}
{% tab title="C#" %}

```csharp
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%"); // Opsiyonel
        client.DefaultRequestHeaders.Add("productid", "%ProductId%");
        var response = await client.GetAsync("{{Private Base Address}}/api/paywall/private/query/by/productid");
        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 List<PaywallList> List { get; set; }
    }

    public class PaywallList
    {
        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...
    }
}
```

{% endtab %}
{% endtabs %}

**The parameters returned by the service are as follows:**

<details>

<summary><strong>Parameter Descriptions (Returns a list)</strong></summary>

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

</details>

{% tabs %}
{% tab title="JSON" %}
{% code lineNumbers="true" %}

```json
{
    "ErrorCodeType": 1,
    "ErrorMessage": null,
    "ErrorCode": 0,
    "Result": true,
    "Message": "",
    "Body": {
        "List": [
            {
                "PaymentId": 23553778,
                "UniqueCode": "0e29be40-bff3-4786-b80d-537d5f68dac0",
                "MerchantUniqueCode": "daff9207-0220-4e69-b4b8-ed5bc78cb9d0",
                "TrackingCode": "tracking-code-1234567890",
                "ActivityId": 58962722,
                "PaymentGatewayId": 1475,
                "PaymentGatewayName": "GatewayName",
                "PaymentGatewayProviderName": "ProviderName",
                "PaymentGatewayProviderKey": "ProviderKey",
                "IsThreeDSecure": false,
                "IsNonThreeDSecure": true,
                "IsInsuranceSecure": false,
                "IsProvision": false,
                "IsOtp": false,
                "AnySuccessPayment": true,
                "AnySuccessRefund": false,
                "AnySuccessPartialRefund": false,
                "AnySuccessCancel": false,
                "IsFullyRefunded": false,
                "PendingProvisionClose": false,
                "RemainingRefundAmount": 1333.30,
                "Error": {
                    "AnyError": false,
                    "ErrorType": 0,
                    "ErrorMessage": ""
                },
                "Status": true,
                "StatusName": "Başarılı",
                "StatusId": 4,
                "TypeName": "Satış",
                "TypeId": 1,
                "Installment": 1,
                "CurrencyId": 1,
                "CurrencyName": "TRY",
                "PaymentMethodId": 2,
                "PaymentMethodName": "Direct Payment",
                "PaymentChannelId": 1,
                "PaymentChannelName": "Web",
                "PaymentTagId": 1090,
                "PaymentTagName": "Tunahanw3",
                "CardNumber": "55287900******0008",
                "CardOwnerName": "Adem Işık",
                "CardBankId": 55,
                "CardBankName": "T.HALK BANKASI A.Ş.",
                "CardBrandId": 1,
                "CardBrandName": "Master Card",
                "CardTypeId": 1,
                "CardTypeName": "Credit",
                "CardFamilyId": 5,
                "CardFamilyName": "Paraf",
                "LastActivityDateTime": "2026-04-20T00:40:53.9291063",
                "PaymentAmount": 1333.30,
                "ActivityAmount": 1333.30,
                "IP": "111.111.111.111",
                "ClientIP": "1.1.1.1",
                "AppliedInterest": true,
                "InterestRate": 33.33,
                "CommissionRate": 25.00,
                "OriginalAmount": 1000.00,
                "InterestAmount": 1333.30,
                "CommissionAmount": 333.32,
                "UsedSavedCard": false,
                "UsedTempCard": false,
                "Activities": [
                    {
                        "Id": 58962720,
                        "PaymentActivityTypeId": 1,
                        "PaymentActivityTypeName": "Satış",
                        "PaymentStatusId": 1,
                        "PaymentStatusName": "Oluşturuldu",
                        "Amount": 1333.30,
                        "DateTime": "2026-04-20T00:40:53.7101308",
                        "PaymentGatewayId": 1475,
                        "PaymentGatewayName": "GatewayName",
                        "PaymentGatewayProviderName": "ProviderName",
                        "PaymentGatewayProviderKey": "ProviderKey"
                    },
                    {
                        "Id": 58962721,
                        "PaymentActivityTypeId": 1,
                        "PaymentActivityTypeName": "Satış",
                        "PaymentStatusId": 2,
                        "PaymentStatusName": "Başladı",
                        "Amount": 1333.30,
                        "DateTime": "2026-04-20T00:40:53.7474352",
                        "PaymentGatewayId": 1475,
                        "PaymentGatewayName": "GatewayName",
                        "PaymentGatewayProviderName": "ProviderName",
                        "PaymentGatewayProviderKey": "ProviderKey"
                    },
                    {
                        "Id": 58962722,
                        "PaymentActivityTypeId": 1,
                        "PaymentActivityTypeName": "Satış",
                        "PaymentStatusId": 4,
                        "PaymentStatusName": "Başarılı",
                        "Amount": 1333.30,
                        "DateTime": "2026-04-20T00:40:53.9291063",
                        "PaymentGatewayId": 1475,
                        "PaymentGatewayName": "GatewayName",
                        "PaymentGatewayProviderName": "ProviderName",
                        "PaymentGatewayProviderKey": "ProviderKey"
                    }
                ],
                "PaymentExternalAuthCode": "",
                "PaymentExternalOrderId": "",
                "PaymentExternalTransId": "",
                "PaymentExternalHostReference": "",
                "PaymentExternalMerchantId": ""
            }
        ]
    }
}
```

{% endcode %}
{% endtab %}
{% endtabs %}

## **Payment Query (ProductId) V2**

<mark style="color:blue;">`GET`</mark> `{{Private Base Address}}/api/paywall/private/query/v2/by/productid`

{% hint style="info" %}
**Important:** To use the Payment Query (by Product Information) service, you must include the **apikeyprivate** and **apiclientprivate** parameters in the **Header** section.\
\
[<mark style="color:green;">**PaymentPrivateAPI Address**</mark>](/payment-orchestration-integration-document/environment.md)
{% endhint %}

{% hint style="warning" %}
**The payment query service using product identifier returns a maximum of 100 records.**
{% endhint %}

**Required headers and request parameters:**

<details>

<summary>Parameters and Descriptions</summary>

<table><thead><tr><th width="215.83203125">Parameter</th><th width="126.7890625">Type</th><th width="168.6484375">Compulsory</th><th width="403">Description</th></tr></thead><tbody><tr><td>apikeyprivate</td><td>string</td><td>Yes</td><td>Public Key obtained from the merchant panel.</td></tr><tr><td>apiclientprivate</td><td>string</td><td>Yes</td><td>Public Client obtained from the merchant panel.</td></tr><tr><td>merchantuniquecode</td><td>string </td><td>Optional</td><td>Unique tracking code assigned by you for the payment.</td></tr><tr><td>productid</td><td>string</td><td>Yes</td><td>The information provided by you in the ProductId parameter related to the payment.</td></tr></tbody></table>

</details>

**Example Code:**

{% tabs %}
{% tab title="C#" %}

```csharp
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%"); // Opsiyonel
        client.DefaultRequestHeaders.Add("productid", "%ProductId%");
        var response = await client.GetAsync("{{Private Base Address}}/api/paywall/private/query/by/productid");
        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 List<PaywallList> List { get; set; }
    }

    public class PaywallList
    {
        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...
    }
}
```

{% endtab %}
{% endtabs %}

**The parameters returned by the service are as follows:**

<details>

<summary><strong>Parameter Descriptions (Returns a list)</strong></summary>

<table><thead><tr><th width="265">Parameter</th><th width="118.33333333333331">Type</th><th>Descriptions</th></tr></thead><tbody><tr><td>PaymentId</td><td>int</td><td>Payment identifier</td></tr><tr><td>UniqueCode</td><td>Guid</td><td>Unique tracking number generated by Paywall for the payment</td></tr><tr><td>MerchantUniqueCode</td><td>string</td><td>Unique tracking number provided by the merchant at the time of payment initiation</td></tr><tr><td>TrackingCode</td><td>string</td><td>Tracking number provided by the merchant at the time of payment initiation</td></tr><tr><td>ActivityId</td><td>int</td><td>Identifier of the last payment activity</td></tr><tr><td>PaymentGatewayId</td><td>int</td><td>Identifier of the payment gateway through which the transaction was processed</td></tr><tr><td>PaymentGatewayName</td><td>string</td><td>Name of the payment gateway through which the transaction was processed</td></tr><tr><td>PaymentGatewayProviderName</td><td>string</td><td>Provider name of the payment gateway in the system</td></tr><tr><td>IsThreeDSecure</td><td>bool</td><td>Is the transaction 3D secure?</td></tr><tr><td>IsNonThreeDSecure</td><td>bool</td><td>Is the transaction Non-3D secure?</td></tr><tr><td>IsInsuranceSecure</td><td>bool</td><td>Is the transaction secured with insurance (first 8 and last 4 digits)?</td></tr><tr><td>IsProvision</td><td>bool</td><td>Is the transaction pre-authorized (provisioned)?</td></tr><tr><td>IsOtp</td><td>bool</td><td>Is the transaction performed using OTP method?</td></tr><tr><td>AnySuccessPayment</td><td>bool</td><td>Is there any successful sale within the transaction scope?</td></tr><tr><td>AnySuccessRefund</td><td>bool</td><td>Is there any successful refund within the transaction scope?</td></tr><tr><td>AnySuccessPartialRefund</td><td>bool</td><td>Is there any successful partial refund within the transaction scope?</td></tr><tr><td>AnySuccessCancel</td><td>bool</td><td>Is there any successful cancellation within the transaction scope?</td></tr><tr><td>Status</td><td>boolean</td><td>Status of the last activity, true: successful / false: failed</td></tr><tr><td>StatusName</td><td>string</td><td>Payment status</td></tr><tr><td>StatusId</td><td>int</td><td>Payment status identifier</td></tr><tr><td>TypeName</td><td>string</td><td>Type of the last payment activity</td></tr><tr><td>TypeId</td><td>int</td><td>Identifier of the last payment activity type</td></tr><tr><td>Installment</td><td>int</td><td>Installment information</td></tr><tr><td>CurrencyId</td><td>int</td><td>Payment currency identifier</td></tr><tr><td>CurrencyName</td><td>string</td><td>Payment currency</td></tr><tr><td>PaymentMethodId</td><td>int</td><td><p>Payment method identifier</p><p><br>See: <a href="/pages/Ry0msBeuGT7JjG6Ij5BH">Payment Methods </a></p></td></tr><tr><td>PaymentMethodName</td><td>string</td><td>Payment method</td></tr><tr><td>PaymentChannelId</td><td>int</td><td>Payment channel identifier<br><br>See: <a href="/pages/6zwTxPFyZq6Gwzaran3f">Payment Channels </a></td></tr><tr><td>PaymentChannelName</td><td>string</td><td>Payment channel</td></tr><tr><td>PaymentTagId</td><td>int</td><td>Payment tag identifier</td></tr><tr><td>PaymentTagName</td><td>string</td><td>Payment tag</td></tr><tr><td>CardNumber</td><td>string</td><td>Masked card number</td></tr><tr><td>CardOwnerName</td><td>string</td><td>Masked cardholder name</td></tr><tr><td>CardBankId</td><td>int</td><td>Identifier of the card's bank</td></tr><tr><td>CardBankName</td><td>string</td><td>Name of the card's bank</td></tr><tr><td>CardBrandId</td><td>int</td><td>Identifier of the card brand</td></tr><tr><td>CardBrandName</td><td>string</td><td>Name of the card brand</td></tr><tr><td>CardTypeId</td><td>int</td><td>Identifier of the card type</td></tr><tr><td>CardTypeName</td><td>string</td><td>Name of the card type</td></tr><tr><td>CardFamilyId</td><td>int</td><td>Identifier of the card family</td></tr><tr><td>CardFamilyName</td><td>string</td><td>Name of the card family</td></tr><tr><td>LastActivityDateTime</td><td>DateTime</td><td>Date and time of the last transaction related to the payment</td></tr><tr><td>PaymentAmount</td><td>decimal</td><td>Total payment amount</td></tr><tr><td>ActivityAmount</td><td>decimal</td><td><p><strong>Last transaction amount</strong></p><p><br><em>Example: If a transaction with a total amount of 1000 TL has a partial refund of 100 TL, this parameter will return 100.</em></p></td></tr><tr><td>IP</td><td>string</td><td>IP address to which the transaction was sent</td></tr><tr><td>ClientIP</td><td>string</td><td>IP address of the device used to initiate the payment</td></tr><tr><td>AppliedInterest</td><td>bool</td><td>Was an installment interest applied to the payment?</td></tr><tr><td>InterestRate</td><td>decimal?</td><td>Applied interest rate</td></tr><tr><td>CommissionRate</td><td>decimal?</td><td><p><strong>Commission applied by the payment provider</strong></p><p><br><em>Returns the value you configured in the Paywall panel.</em></p></td></tr><tr><td>OriginalAmount</td><td>decimal</td><td><p><strong>Original payment amount</strong></p><p><br><em>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.</em></p></td></tr><tr><td>InterestAmount</td><td>decimal?</td><td>If applicable, the applied installment interest amount</td></tr><tr><td>CommissionAmount</td><td>decimal</td><td>Commission amount applied to the payment by the payment institution/bank</td></tr><tr><td>UsedSavedCard</td><td>bool</td><td>Was the payment made using a saved card?</td></tr><tr><td>UsedTempCard</td><td>bool</td><td>Was the payment made using a client-side tokenized card?</td></tr><tr><td>Activities</td><td>List</td><td>All actions related to the transaction (Created, Sale Started, Sale Failed, Cancellation Successful, etc.)</td></tr><tr><td>IsFullyRefunded</td><td>bool</td><td>Information on whether the transaction has been fully canceled/refunded.</td></tr><tr><td>RemainingRefundAmount</td><td>decimal</td><td>Total refundable amount. This amount decreases as partial refunds are made.</td></tr><tr><td>PaymentExternalAuthCode</td><td>string</td><td>For this parameter to be populated, the provider (Bank/PF) must return a value.</td></tr><tr><td>PaymentExternalOrderId</td><td>string</td><td>For this parameter to be populated, the provider (Bank/PF) must return a value.</td></tr><tr><td>PaymentExternalTransId</td><td>string</td><td>For this parameter to be populated, the provider (Bank/PF) must return a value.</td></tr><tr><td>PaymentExternalHostReference</td><td>string</td><td>For this parameter to be populated, the provider (Bank/PF) must return a value.</td></tr><tr><td>PaymentExternalMerchantId</td><td>string</td><td>For this parameter to be populated, the provider (Bank/PF) must return a value.</td></tr><tr><td>FirstActivityDateTime</td><td>DateTime</td><td>The date of the first activity of the payment</td></tr><tr><td>PendingProvisionClose</td><td>bool</td><td>Is the pre-authorization closure pending?</td></tr><tr><td>PosType</td><td>int</td><td>POS type of the activity</td></tr><tr><td>DayCount</td><td>int</td><td>POS day count of the activity</td></tr><tr><td>Commission</td><td>decimal</td><td>Commission rate applied to the activity</td></tr><tr><td>Interest</td><td>decimal</td><td>Interest rate applied to the activity</td></tr><tr><td>OriginalAmount</td><td>decimal</td><td>Original amount of the activity</td></tr><tr><td>InterestAmount</td><td>decimal</td><td>Interest amount applied to the activity</td></tr><tr><td>AppliedInterest</td><td>bool</td><td>Was interest applied to the activity?</td></tr><tr><td>AfterPartialRefundOriginalAmount</td><td>decimal</td><td>Remaining original amount after partial refund</td></tr><tr><td>IsPartialRefund</td><td>bool</td><td>Does the activity belong to a partial refund transaction?</td></tr></tbody></table>

</details>

{% tabs %}
{% tab title="JSON" %}
{% code lineNumbers="true" %}

```json
	{
	    "ErrorCodeType": 1,
	    "ErrorMessage": null,
	    "ErrorCode": 0,
	    "Result": true,
	    "Message": "",
	    "Body": {
	        "List": [
	            {
	                "PaymentId": 21803638,
	                "UniqueCode": "e1b4460c-e07c-43bc-84b7-94bc492d0201",
	                "MerchantUniqueCode": "5ed7064c-4a5f-4b47-8806-665b6c7513fa",
	                "TrackingCode": "tracking-code-1234567890",
	                "ActivityId": 59338686,
	                "PaymentGatewayId": 1545,
	                "PaymentGatewayName": "GatewayName",
	                "PaymentGatewayProviderName": "ProviderName",
	                "PaymentGatewayProviderKey": "ProviderKey",
	                "IsThreeDSecure": false,
	                "IsNonThreeDSecure": true,
	                "IsInsuranceSecure": false,
	                "IsProvision": false,
	                "IsOtp": false,
	                "AnySuccessPayment": false,
	                "AnySuccessRefund": false,
	                "AnySuccessPartialRefund": false,
	                "AnySuccessCancel": false,
	                "IsFullyRefunded": false,
	                "PendingProvisionClose": false,
	                "RemainingRefundAmount": 1000,
	                "Error": {
	                    "AnyError": false,
	                    "ErrorType": 0,
	                    "ErrorMessage": ""
	                },
	                "Status": false,
	                "StatusName": "Oluşturuldu",
	                "StatusId": 1,
	                "TypeName": "Satış",
	                "TypeId": 1,
	                "Installment": 1,
	                "CurrencyId": 1,
	                "CurrencyName": "TRY",
	                "PaymentMethodId": 2,
	                "PaymentMethodName": "Direct Payment",
	                "PaymentChannelId": 1,
	                "PaymentChannelName": "Web",
	                "PaymentTagId": 0,
	                "PaymentTagName": null,
	                "CardNumber": "55287900******0008",
	                "CardOwnerName": "Test Kart",
	                "CardBankId": 55,
	                "CardBankName": "T.HALK BANKASI A.Ş.",
	                "CardBrandId": 1,
	                "CardBrandName": "Master Card",
	                "CardTypeId": 1,
	                "CardTypeName": "Credit",
	                "CardFamilyId": 5,
	                "CardFamilyName": "Paraf",
	                "DateTime": "2026-04-22T17:26:35.388587",
	                "FirstActivityDateTime": "2026-04-22T17:26:36.204871",
	                "LastActivityDateTime": "2026-04-22T17:26:36.204871",
	                "PaymentAmount": 1000,
	                "ActivityAmount": 1000,
	                "IP": "111.111.111.111",
	                "ClientIP": "1.1.1.1",
	                "AppliedInterest": false,
	                "InterestRate": 0,
	                "CommissionRate": 1,
	                "OriginalAmount": 1000,
	                "InterestAmount": 0,
	                "CommissionAmount": 10,
	                "UsedSavedCard": false,
	                "UsedTempCard": false,
	                "Activities": [
	                    {
	                        "Id": 59338686,
	                        "PaymentActivityTypeId": 1,
	                        "PaymentActivityTypeName": "Satış",
	                        "PaymentStatusId": 1,
	                        "PaymentStatusName": "Oluşturuldu",
	                        "Amount": 1000,
	                        "DateTime": "2026-04-22T17:26:36.204871",
	                        "PaymentGatewayId": 1545,
	                        "PaymentGatewayName": "GatewayName",
	                        "PaymentGatewayProviderName": "ProviderName",
	                        "PaymentGatewayProviderKey": "ProviderKey",
	                        "PosType": 2,
	                        "DayCount": 5,
	                        "OriginalAmount": 1000,
	                        "InterestAmount": 0,
	                        "Commission": 1,
	                        "Interest": 0,
	                        "AppliedInterest": false,
	                        "AfterPartialRefundOriginalAmount": 0,
	                        "IsPartialRefund": false
	                    }
	                ],
	                "PaymentExternalAuthCode": "",
	                "PaymentExternalOrderId": "",
	                "PaymentExternalTransId": "",
	                "PaymentExternalHostReference": "",
	                "PaymentExternalMerchantId": ""
	            },
	            {
	                "PaymentId": 21803633,
	                "UniqueCode": "c24011c1-af1b-41eb-a9fe-d71a075a77db",
	                "MerchantUniqueCode": "6889ab95-4440-49f2-8b77-ea99446145fc",
	                "TrackingCode": "tracking-code-1234567890",
	                "ActivityId": 59338676,
	                "PaymentGatewayId": 1545,
	                "PaymentGatewayName": "GatewayName",
	                "PaymentGatewayProviderName": "ProviderName",
	                "PaymentGatewayProviderKey": "ProviderKey",
	                "IsThreeDSecure": false,
	                "IsNonThreeDSecure": true,
	                "IsInsuranceSecure": false,
	                "IsProvision": false,
	                "IsOtp": false,
	                "AnySuccessPayment": false,
	                "AnySuccessRefund": false,
	                "AnySuccessPartialRefund": false,
	                "AnySuccessCancel": false,
	                "IsFullyRefunded": false,
	                "PendingProvisionClose": false,
	                "RemainingRefundAmount": 1000,
	                "Error": {
	                    "AnyError": true,
	                    "ErrorType": 1,
	                    "ErrorMessage": "Provider: Bankasina Ulasilamiyor. - Işleminizi Gerçekleştiremiyoruz.Tekrar Deneyiniz"
	                },
	                "Status": false,
	                "StatusName": "Başarısız",
	                "StatusId": 5,
	                "TypeName": "Satış",
	                "TypeId": 1,
	                "Installment": 1,
	                "CurrencyId": 1,
	                "CurrencyName": "TRY",
	                "PaymentMethodId": 2,
	                "PaymentMethodName": "Direct Payment",
	                "PaymentChannelId": 1,
	                "PaymentChannelName": "Web",
	                "PaymentTagId": 0,
	                "PaymentTagName": null,
	                "CardNumber": "55287900******0008",
	                "CardOwnerName": "Test Kart",
	                "CardBankId": 55,
	                "CardBankName": "T.HALK BANKASI A.Ş.",
	                "CardBrandId": 1,
	                "CardBrandName": "Master Card",
	                "CardTypeId": 1,
	                "CardTypeName": "Credit",
	                "CardFamilyId": 5,
	                "CardFamilyName": "Paraf",
	                "DateTime": "2026-04-22T17:06:32.541739",
	                "FirstActivityDateTime": "2026-04-22T17:06:32.865279",
	                "LastActivityDateTime": "2026-04-22T17:06:56.023137",
	                "PaymentAmount": 1000,
	                "ActivityAmount": 1000,
	                "IP": "111.111.111.111",
	                "ClientIP": "1.1.1.1",
	                "AppliedInterest": false,
	                "InterestRate": 0,
	                "CommissionRate": 0,
	                "OriginalAmount": 1000,
	                "InterestAmount": 0,
	                "CommissionAmount": 0,
	                "UsedSavedCard": false,
	                "UsedTempCard": false,
	                "Activities": [
	                    {
	                        "Id": 59338671,
	                        "PaymentActivityTypeId": 1,
	                        "PaymentActivityTypeName": "Satış",
	                        "PaymentStatusId": 1,
	                        "PaymentStatusName": "Oluşturuldu",
	                        "Amount": 1000,
	                        "DateTime": "2026-04-22T17:06:32.865279",
	                        "PaymentGatewayId": 1545,
	                        "PaymentGatewayName": "GatewayName",
	                        "PaymentGatewayProviderName": "ProviderName",
	                        "PaymentGatewayProviderKey": "ProviderKey",
	                        "PosType": 2,
	                        "DayCount": 5,
	                        "OriginalAmount": 1000,
	                        "InterestAmount": 0,
	                        "Commission": 0,
	                        "Interest": 0,
	                        "AppliedInterest": false,
	                        "AfterPartialRefundOriginalAmount": 0,
	                        "IsPartialRefund": false
	                    },
	                    {
	                        "Id": 59338675,
	                        "PaymentActivityTypeId": 1,
	                        "PaymentActivityTypeName": "Satış",
	                        "PaymentStatusId": 2,
	                        "PaymentStatusName": "Başladı",
	                        "Amount": 1000,
	                        "DateTime": "2026-04-22T17:06:33.778812",
	                        "PaymentGatewayId": 1545,
	                        "PaymentGatewayName": "GatewayName",
	                        "PaymentGatewayProviderName": "ProviderName",
	                        "PaymentGatewayProviderKey": "ProviderKey",
	                        "PosType": 2,
	                        "DayCount": 5,
	                        "OriginalAmount": 1000,
	                        "InterestAmount": 0,
	                        "Commission": 0,
	                        "Interest": 0,
	                        "AppliedInterest": false,
	                        "AfterPartialRefundOriginalAmount": 0,
	                        "IsPartialRefund": false
	                    },
	                    {
	                        "Id": 59338676,
	                        "PaymentActivityTypeId": 1,
	                        "PaymentActivityTypeName": "Satış",
	                        "PaymentStatusId": 5,
	                        "PaymentStatusName": "Başarısız",
	                        "Amount": 1000,
	                        "DateTime": "2026-04-22T17:06:56.023137",
	                        "PaymentGatewayId": 1545,
	                        "PaymentGatewayName": "GatewayName",
	                        "PaymentGatewayProviderName": "ProviderName",
	                        "PaymentGatewayProviderKey": "ProviderKey",
	                        "PosType": 2,
	                        "DayCount": 5,
	                        "OriginalAmount": 1000,
	                        "InterestAmount": 0,
	                        "Commission": 0,
	                        "Interest": 0,
	                        "AppliedInterest": false,
	                        "AfterPartialRefundOriginalAmount": 0,
	                        "IsPartialRefund": false
	                    }
	                ],
	                "PaymentExternalAuthCode": "",
	                "PaymentExternalOrderId": "",
	                "PaymentExternalTransId": "",
	                "PaymentExternalHostReference": "",
	                "PaymentExternalMerchantId": ""
	            }
	        ]
	    }
	}
```

{% endcode %}
{% endtab %}
{% endtabs %}