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 User) is not advised.

Save New Card

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

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

CardWallAPI Address

The parameters to be sent to the service (HEADERS) are as follows:

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

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

Parameter	Type	Compulsory	Description
RelationalId1	string	Yes	The unique information requested to associate the card.
RelationalId2	string	No	The unique second piece of information requested to associate the card (all information must be sent at the time of listing).
RelationalId3	string	No	The unique third piece of information requested to associate the card (all information must be sent at the time of listing).
Nickname	string	Yes	The card's nickname (Example: My high-limit card )
HolderName	string	Yes	The cardholder's name on the card.
CardBin	string	Yes	The first 6 or 8 digits of the card.
CardLastFour	string	Yes	The last 4 digits of the card number.
Identity	string	Yes	The cardholder's identity number or tax identification number.
Month	int	Yes	The card's expiration date (month).
Year	int	Yes	The card's expiration date (year) - The parameter must be 4 characters.
IncludeDetails	boolean	No	If you want the card's detailed information (BIN, Type, Brand, Bank, etc.) to be returned, you should send TRUE.

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

JSON

{
    "RelationalId1": "003", 
    "RelationalId2": null,
    "RelationalId3": null,
    "Card": {
        "Nickname": "test kartı",
        "HolderName": "Test Kartı",
        "CardBin": "41197901",
        "CardLastFour": "6389",
        "Identity": "17654932298",
        "Month": 11,
        "Year": 2040
    },
    "IncludeDetails": true
}

The parameters returned by the service are as follows:

Parameter	Type	Description
ErrorCode	int	Error code. If the transaction is successful, it returns the value '0'.
Result	bool	It returns a true or false value. If the transaction is successful, it returns the value 'true'.
Message	string	If the transaction is erroneous, this is the message related to the error, and it provides language support based on the locale parameter.
Body	object	If the transaction is erroneous, this is the detail object related to the error.

JSON

{
    "ErrorCode": 0,
    "Result": true,
    "Message": "",
    "Body": {
        "Scope": 2,
        "Name": "test kartı",
        "Identity": "176****298",
        "CardBin": "41197901",
        "CardLastFour": "6389",
        "CardHolderName": "Test Kartı",
        "CardTypeId": 1,
        "CardType": "Credit",
        "Month": 11,
        "Year": 2040,
        "UniqueCode": "PLUg7DMV88LRBnQ2SvssryFDUBmWM2G4wYlT+BEqm1AAPy6BKz+wBA==",
        "Details": {
            "CardBankId": 56,
            "CardBank": "T. VAKIFLAR BANKASI T.A.O.",
            "CardBrandId": 2,
            "CardBrand": "Visa",
            "CardFamilyId": 1,
            "CardFamily": "World",
            "CardKindId": 1,
            "CardKind": "Bireysel Kart",
            "CardTypeId": 1,
            "CardType": "Credit"
        }
    }
}