# 7. Card List

## **Card List**

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

{% hint style="info" %}
**Important:** To use the APM Card List service, you must include the **apikeypublic** and **apiclientpublic** parameters in the **Header** section.\
\
[<mark style="color:green;">**PaymentAPI Address**</mark>](https://developer.paywall.one/payment-orchestration-integration-document/environment)
{% endhint %}

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

<table><thead><tr><th width="204.0859375">Parameter</th><th width="124.34375">Type</th><th width="142.66015625">Compulsory</th><th width="403">Açıklama</th></tr></thead><tbody><tr><td>apikeypublic</td><td>string</td><td>Yes</td><td>The Public Key obtained from the merchant panel.</td></tr><tr><td>apiclientpublic</td><td>string</td><td>Yes</td><td>The Public Client obtained from the merchant panel.</td></tr></tbody></table>

**The (BODY) parameters that must be sent to the service are as follows:**

<table><thead><tr><th width="225">Parameter</th><th width="127.36328125">Type</th><th width="164.78515625">Compulsory</th><th width="336">Description</th></tr></thead><tbody><tr><td>currencyid</td><td>string</td><td>Yes</td><td>This is the <code>UniqueCode</code> parameter related to the APM payment. It is included in the response returned by the API at the time of creation.</td></tr><tr><td>apmconnectionid</td><td>int</td><td>Yes/No</td><td>This is the connection ID number of the APM provider in your account.</td></tr><tr><td>providerkey</td><td>string</td><td>Yes/No</td><td>The static key information of the APM provider in the Paywall system.</td></tr><tr><td>externalid</td><td>string</td><td>Yes</td><td><p>Information associated with the cards</p><p></p><p>Example:</p><p></p><ul><li>Masterpass Recurring</li><li>Paye Msidn</li></ul></td></tr></tbody></table>

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

<table><thead><tr><th width="189">Parameter</th><th width="100.33333333333331">Type</th><th>Description</th></tr></thead><tbody><tr><td>ErrorCode</td><td>int</td><td>Error code. Returns a value of '0' if the operation is successful.</td></tr><tr><td>Result</td><td>bool</td><td>Returns a value of <strong>true</strong> or <strong>false</strong>. If the operation is successful, it returns <strong>true</strong>.</td></tr><tr><td>Message</td><td>string</td><td>If the operation fails, this is the error message provided. It supports language localization based on the <strong>locale</strong> parameter.</td></tr><tr><td>Body</td><td>object</td><td>If the operation fails, this is the detailed object related to the error.</td></tr></tbody></table>

```json
{
    "ErrorCodeType": 1,
    "ErrorMessage": null,
    "ErrorCode": 0,
    "Result": true,
    "Message": "",
    "Body": [
        {
            "Id": "4000000053337",
            "Alias": "Kart1",
            "Number": "************0008",
            "ExternalId": null,
            "OrderAmount": "500000",
            "ExpireDate": "2026-01-17T00:00:00",
            "InsertDate": "2025-07-20T21:10:05.7927086",
            "ProductId": "191"
        },
        {
            "Id": "4000000060387",
            "Alias": "Kart2",
            "Number": "************0006",
            "ExternalId": null,
            "OrderAmount": "500000",
            "ExpireDate": "2026-01-17T00:00:00",
            "InsertDate": "2025-07-21T16:29:40.1905498",
            "ProductId": "191"
        }
    ]
}
```
