# 2. List Cards

## List cards

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

{% hint style="info" %}
**Important**: Card transactions are high-security operations. Therefore, you need to send the '**apikeyprivate**' and '**apiclientprivate**' parameters in the 'Header' field.

\
[<mark style="color:green;">**CardWallAPI Address**</mark>](https://developer.paywall.one/payment-orchestration-integration-document/environment)
{% endhint %}

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

<table><thead><tr><th width="231">Parameters (Headers)</th><th width="95">Type</th><th width="160">Compulsory </th><th width="403">Description</th></tr></thead><tbody><tr><td>apikeyprivate</td><td>string</td><td>Yes</td><td>The Private Key obtained from the merchant panel.</td></tr><tr><td>apiclientprivate</td><td>string</td><td>Yes</td><td>The Private Client obtained from the merchant panel.</td></tr><tr><td>relationalid1</td><td>string</td><td>Yes</td><td>The first associated value of the registered card.</td></tr><tr><td>relationalid2</td><td>string</td><td>No</td><td>The second associated value of the registered card.</td></tr><tr><td>relationalid3</td><td>string</td><td>No</td><td>The third associated value of the registered card.</td></tr><tr><td>includedetails</td><td>bool</td><td>No</td><td>To get the details of card like Bin, Bank, Type, Brand etc set that parameters as <code>TRUE</code></td></tr><tr><td>partneridentity</td><td>bool</td><td>No</td><td>For the card registered under the partnership, the partner account's identity information must be provided.</td></tr></tbody></table>

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

<table><thead><tr><th width="184.33333333333331">Parameter</th><th width="189">Type</th><th>Description</th></tr></thead><tbody><tr><td>Name</td><td>string</td><td>The nickname provided during card addition.</td></tr><tr><td>CardBin</td><td>string</td><td>The BIN (Bank Identification Number) information associated with 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>Masked card number. You can list it on your screens.</td></tr><tr><td>Expired</td><td>boolean</td><td>Indicates whether the card has expired or not. If '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>It returns the brand of the card as a string.</td></tr><tr><td>UniqueCode</td><td>string</td><td>The card identifier that should be used when making a payment with the card. This information changes at certain intervals. Therefore, the UniqueCode information of the registered card should not be stored. The list of cards should be obtained from Paywall before each payment.</td></tr></tbody></table>

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

```json
{
    "ErrorCode": 0,
    "Result": true,
    "Message": "",
    "Body": [
        {
            "Name": "Test Card",
            "CardBin": "453144",
            "CardLastFour": "2283",
            "CardHolderName": "Emir Selim Tütüncü",
            "CardNumber": "453144******2283",
            "Expired": false,
            "CardTypeId": 0,
            "CardType": "Visa",
            "Month": 12,
            "Year": 2025,
            "UniqueCode": "VtsSMsRKBLJMZBApXZrlyTLmKwu6SGYiSFl7/Q2n1d0j5Pon9uA6GQ==",
            "Details": {
                "CardBankId": 77,
                "CardBank": "AKTİF YATIRIM BANKASI A.Ş.",
                "CardBrandId": 2,
                "CardBrand": "Visa",
                "CardFamilyId": 5,
                "CardFamily": "Paraf",
                "CardKindId": 1,
                "CardKind": "Bireysel Kart",
                "CardTypeId": 1,
                "CardType": "Credit"
            }
        },
        {
            "Name": "EnesIsbank",
            "CardBin": "552879",
            "CardLastFour": "0008",
            "CardHolderName": "Enes Selman Tütüncü",
            "CardNumber": "552879******0008",
            "Expired": false,
            "CardTypeId": 1,
            "CardType": "MasterCard",
            "Month": 9,
            "Year": 2027,
            "UniqueCode": "GG76g2CXnNky6rJEH5UOYYHZZzfONZhWS83O5/Ah5TUmmZ74oF0Ahw==",
            "Details": {
                "CardBankId": 55,
                "CardBank": "T.HALK BANKASI A.Ş.",
                "CardBrandId": 1,
                "CardBrand": "Master Card",
                "CardFamilyId": 5,
                "CardFamily": "Paraf",
                "CardKindId": 2,
                "CardKind": "Ticari Kart",
                "CardTypeId": 1,
                "CardType": "Credit"
            }
        }
        {
            "Name": "thryhrt",
            "CardBin": "552879",
            "CardLastFour": "0008",
            "CardHolderName": "thryhrt",
            "CardNumber": "552879******0008",
            "Expired": false,
            "CardTypeId": 1,
            "CardType": "MasterCard",
            "Month": 12,
            "Year": 2030,
            "UniqueCode": "bzkBzQ5bH9KOtZ+wgI4RiVxBH2WYF9QeYC94wCqwAn51vC7wrYR4wA==",
            "Details": {
                "CardBankId": 55,
                "CardBank": "T.HALK BANKASI A.Ş.",
                "CardBrandId": 1,
                "CardBrand": "Master Card",
                "CardFamilyId": 5,
                "CardFamily": "Paraf",
                "CardKindId": 2,
                "CardKind": "Ticari Kart",
                "CardTypeId": 1,
                "CardType": "Credit"
            }
        },
        {
            "Name": "thryhrt",
            "CardBin": "552879",
            "CardLastFour": "0008",
            "CardHolderName": "thryhrt",
            "CardNumber": "552879******0008",
            "Expired": false,
            "CardTypeId": 1,
            "CardType": "MasterCard",
            "Month": 12,
            "Year": 2030,
            "UniqueCode": "IiPYc67bYVYrChRnB4ThSVMERFSw5Vt2PUaBcXeKw9HBTwWqXOSbdQ==",
            "Details": {
                "CardBankId": 55,
                "CardBank": "T.HALK BANKASI A.Ş.",
                "CardBrandId": 1,
                "CardBrand": "Master Card",
                "CardFamilyId": 5,
                "CardFamily": "Paraf",
                "CardKindId": 2,
                "CardKind": "Ticari Kart",
                "CardTypeId": 1,
                "CardType": "Credit"
            }
        }
    ]
}
```

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