1. New Card

It is recommended to perform the process of adding a new card only through your servers (Back-End). Direct access from your applications (End Users) is not recommended.

Store New Card

POST {{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 (HEADERS) that need to be sent to the service are as follows:

Parameter	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.

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

Parameter	Type	Compulsory	Description
RelationalId1	string	Yes	The unique information that the card is to be associated with.
RelationalId2	string	No	The second unique information that the card is to be associated with (all information should be sent during listing).
RelationalId3	string	No	The third unique information that the card is to be associated with (all information should be sent during listing).
Nickname	string	Yes	The nickname of the card (Example: My High Limit Card :))
HolderName	string	Yes	The name of the cardholder on the card.
Number	string	Yes	The card number
Month	int	Yes	The expiration date of the card (month)
Year	int	Yes	The expiration date of the card (year) - The parameter should be 4 characters.
IncludeDetails	boolean	No	To get the details of card like Bin, Bank, Type, Brand etc set that parameters as TRUE

An example JSON file to be sent to the service is as follows:

JSON

{
    "PartnerBased": false,
    "PartnerIdentity": "",
    "RelationalId1": "1000923",
    "RelationalId2": "",
    "RelationalId3": "",
    "Card": {
        "Nickname": "İş bankası kartım",
        "HolderName": "Emir Selim Tütüncü",
        "Number": "4546711234567894",
        "Month": 12,
        "Year": 2026
    },
    "IncludeDetails": true
}

The parameters returned from the service are as follows:

Parameter	Type	Explanation
ErrorCode	int	Error code. If the transaction is successful, it returns a value of '0'.
Result	bool	It returns either true or false. If the transaction is successful, it returns 'true'.
Message	string	If the transaction is unsuccessful, this is the message specified for the error, providing language support based on the 'locale' parameter.
Body	object	If the transaction is unsuccessful, this is the detail object for the error.

JSON

{
    "ErrorCode": 0,
    "Result": true,
    "Message": "",
    "Body": {
        "Name": "İş bankası kartım",
        "CardBin": "444676",
        "CardLastFour": "3623",
        "CardHolderName": "E*i* S*l*m T*t*n*ü",
        "CardNumber": "454671******7894",
        "CardTypeId": 0,
        "CardType": "Visa",
        "Month": 12,
        "Year": 2026,
        "UniqueCode": "hNNqz1Yy2sb59BSKdF1S0pgrwBWvUuNxG8WiVq4T1AgK56FQljAlKQ==",
        "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"
        }
    }
}