2. Saved Cards

It is recommended to retrieve saved card data only through your servers (Back-End). Direct access from your applications (End User) is not advised.

Saved Card List

GET {{Base Adres}}/paywall/card/insurance

Important: Card transactions are high-security operations. Therefore, you must send the 'apikeyprivate' and 'apiclientprivate' parameters in the 'Header' section.

CardWallAPI Address

The parameters to be sent to the service are as follows:

Parameter (Headers)	Type	Compulsory	Description
apikeyprivate	string	Yes	The Private Key obtained from the merchant's admin panel.
apiclientprivate	string	Yes	The Private Client obtained from the merchant's admin panel.
relationalid1	string	Yes	The first associated value of the saved card.
relationalid2	string	No	The second associated value of the saved card.
relationalid3	string	No	The third associated value of the saved card.
includedetails	boolean	No	If you want the card's detailed information (BIN, Type, Brand, Bank, etc.) to be returned, you must send TRUE.

The parameters returned by the service are as follows:

Parameter	Type	Description
Name	string	The nickname provided during card addition.
CardBin	string	The BIN information of the card.
CardLastFour	string	The last 4 digits of the card.
Identity	string	The cardholder's identity number or tax identification number.
Expired	boolean	Indicates whether the card's expiration date has passed or not. If "True" is returned, payments cannot be processed with that card.
Scope	int	It is the parameter that indicates the area in which the card will be used.
CardTypeId	int	It represents the brand of the card, such as MasterCard, Visa, etc.
CardType	string	It returns the card's brand as a string.
UniqueCode	string	It is the card identifier to be used when making a payment with the card. This information changes at regular intervals. Therefore, the UniqueCode information of the saved card should not be stored. A card list should be retrieved from Paywall before each payment.

JSON

"ErrorCode": 0,
    "Result": true,
    "Message": "",
    "Body": [
        {
            "Scope": 2,
            "Name": "test kartı",
            "Identity": "",
            "CardBin": "45467121",
            "CardLastFour": "7894",
            "CardHolderName": "Test Kartı",
            "Expired": false,
            "CardTypeId": 1,
            "CardType": "Credit",
            "Month": 12,
            "Year": 2025,
            "UniqueCode": "30H4WW7Es/HHB7l8PFvl+XnMQs1h0d2/cX7E5H9LgzOw1Ef0E7whSQ==",
            "Details": {
                "CardBankId": 53,
                "CardBank": "T.C.ZİRAAT BANKASI A.Ş.",
                "CardBrandId": 2,
                "CardBrand": "Visa",
                "CardFamilyId": 7,
                "CardFamily": "Combo",
                "CardKindId": 1,
                "CardKind": "Bireysel Kart",
                "CardTypeId": 1,
                "CardType": "Credit"
            }
        },
        {
            "Scope": 2,
            "Name": "test kartı",
            "Identity": "273******602",
            "CardBin": "43550930",
            "CardLastFour": "7894",
            "CardHolderName": "Test Kartı",
            "Expired": false,
            "CardTypeId": 1,
            "CardType": "Credit",
            "Month": 12,
            "Year": 2025,
            "UniqueCode": "EzqrWIPvZAewotdQ48DRsrnu/WBfOwvOctM11rOaeEMvYDqGZzpPxA==",
            "Details": {
                "CardBankId": 58,
                "CardBank": "AKBANK T.A.Ş.",
                "CardBrandId": 2,
                "CardBrand": "Visa",
                "CardFamilyId": 4,
                "CardFamily": "Axess",
                "CardKindId": 1,
                "CardKind": "Bireysel Kart",
                "CardTypeId": 1,
                "CardType": "Credit"
            }
        }