2. List Cards

It is recommended to list card data only through your servers (Back-End). Direct access from your applications (End Users) is not recommended.

List cards

GET {{Base Adres}}/paywall/card

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

CardWallAPI Address

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

Parameters (Headers)
Type
Compulsory
Description

apikeyprivate

string

Yes

The Private Key obtained from the merchant panel.

apiclientprivate

string

Yes

The Private Client obtained from the merchant panel.

relationalid1

string

Yes

The first associated value of the registered card.

relationalid2

string

No

The second associated value of the registered card.

relationalid3

string

No

The third associated value of the registered card.

includedetails

bool

No

To get the details of card like Bin, Bank, Type, Brand etc set that parameters as TRUE

partneridentity

bool

No

For the card registered under the partnership, the partner account's identity information must be provided.

The parameters returned from the service are as follows:

Parameter
Type
Description

Name

string

The nickname provided during card addition.

CardBin

string

The BIN (Bank Identification Number) information associated with the card.

CardLastFour

string

The last 4 digits of the card.

CardNumber

string

Masked card number. You can list it on your screens.

Expired

boolean

Indicates whether the card has expired or not. If 'True', payments cannot be made with that card.

CardTypeId

int

Indicates the brand of the card. MasterCard, Visa, etc.

CardType

string

It returns the brand of the card as a string.

UniqueCode

string

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.

{
    "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"
            }
        }
    ]
}

Last updated