# 3. Query

## Stored card list

<mark style="color:blue;">`GET`</mark> `{{Base Adres}}/paywall/blacklist/card/inquiry`

{% hint style="info" %}
Önemli: Kart işlemleri yüksek güvenlikli işlemlerdir. Bu nedenle 'Header' alanında '**apikeyprivate**' ve '**apiclientprivate**' parametrelerini göndermeniz gerekmektedir.\
\
[<mark style="color:green;">**CardWallAPI Address**</mark>](/payment-orchestration-integration-document/environment.md)
{% endhint %}

#### &#x20;The parameters that must be sent to the service are as follows:

<table><thead><tr><th width="186">Parameter</th><th width="115.21484375">Type</th><th width="151.05078125">Compulsory</th><th width="403">Description</th></tr></thead><tbody><tr><td>apikeyprivate</td><td>string</td><td>Yes</td><td>The Private Key you obtained from the merchant panel.</td></tr><tr><td>apiclientprivate</td><td>string</td><td>Yes</td><td>The Private Key you obtained from the merchant panel.</td></tr><tr><td>partnerbased</td><td>bool</td><td>No</td><td>It should be sent as <strong>true</strong> for cards registered within the scope of Partnership.</td></tr><tr><td>partneridentity</td><td>bool</td><td>Yes/No</td><td>For cards registered within the scope of Partnership, the identity information of the Partner account must be provided.</td></tr><tr><td>cardnumber</td><td>string</td><td>Yes</td><td>The card number to be added to the blacklist.</td></tr><tr><td>issavedcard</td><td>bool</td><td>Yes</td><td>It should be sent as <strong>true</strong> if the query will be performed using a stored card.</td></tr><tr><td>uniquecode</td><td>string</td><td>Yes/No</td><td>The identity value of the stored card.</td></tr></tbody></table>

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

<table><thead><tr><th width="184.33333333333331">Parameter</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td>Name</td><td>string</td><td>The alias name provided when adding the card.</td></tr><tr><td>CardBin</td><td>string</td><td>The BIN information of the card.</td></tr><tr><td>CardLastFour</td><td>string</td><td>The last 4 digits of the card.</td></tr><tr><td>CardNumber</td><td>string</td><td>The masked card number. You can display it on your screens.</td></tr><tr><td>Expired</td><td>boolean</td><td>Indicates whether the card’s expiration date has passed or not. If it returns true, payments cannot be made with that card.</td></tr><tr><td>CardTypeId</td><td>int</td><td>Indicates the brand of the card (MasterCard, Visa, etc.).</td></tr><tr><td>CardType</td><td>string</td><td>Returns the card brand as a string.</td></tr><tr><td>UniqueCode</td><td>string</td><td>This is the card identifier that must be used when making a payment with the card. This value changes periodically. Therefore, the UniqueCode information of the stored card should not be stored. The card list should be retrieved from Paywall before each payment.</td></tr></tbody></table>

{% tabs %}
{% tab title="✅ Successful" %}
{% code lineNumbers="true" %}

```json
{
    "ErrorCode": 0,
    "Result": true,
    "Message": "",
    "Body": {
        "Id": "25dfec7f-d5b5-4fdc-b4fa-df2b3e58c8aa",
        "InsertDateTimeUtc": "2025-08-06T10:40:30.328134Z",
        "UpdateDateTimeUtc": "0001-01-01T00:00:00",
        "InBlackList": true,
        "IsActive": true
    }
}
```

{% endcode %}
{% endtab %}

{% tab title="❌ Failed" %}
{% code lineNumbers="true" %}

```json
{
    "ErrorCode": 0,
    "Result": true,
    "Message": "",
    "Body": {
        "Id": "00000000-0000-0000-0000-000000000000",
        "InsertDateTimeUtc": "0001-01-01T00:00:00",
        "UpdateDateTimeUtc": "0001-01-01T00:00:00",
        "InBlackList": false,
        "IsActive": false
    }
}
```

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


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://developer.paywall.one/payment-orchestration-integration-document/card-storage-service/blacklist/3.-query.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.