2. New Card / Tokenization

You can store the tokenized card information obtained via the client on your servers, along with the relevant user details.

Save New Card / Tokenization

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

Important: Card operations are highly secure transactions. Therefore, you must include the apikeyprivate and apiclientprivate parameters in the Header. CardWallAPI Address

The (HEADERS) parameters 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 Key obtained from the merchant panel.

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

Parameter	Type	Compulsory	Description
PartnerBased	bool	No	If the cards are to be stored in a shared pool within the scope of Partnership management, it should be used.
PartnerIdentity	string	Yes/No	If it will be registered within the scope of Partnership, the identity information of your Partner account.
RelationalId1	string	Yes	The unique information to which the card is requested to be linked.
RelationalId2	string	No	The second unique information to which the card is requested to be linked (all information must be sent during listing).
RelationalId3	string	No	The third unique information to which the card is requested to be linked (all information must be sent during listing).
Nickname	string	Yes	The alias name of the card (Example: My high-limit card).
CardToken	Guid	Yes	The tokenized card information itself, provided by the Client.
IncludeDetails	boolean	No	If you want the card details (BIN, Type, Brand, Bank, etc.) to be returned, you must send it as TRUE.

A sample JSON file to be sent to the service is as follows

JSON

{
    "PartnerBased": false,
    "PartnerIdentity": "",
    "RelationalId1": "1000923",
    "RelationalId2": "",
    "RelationalId3": "",
    "Card": {
        "CardToken": "580a3866-0055-4486-8c4b-96c8ac173e32",
        "Nickname": "Test Nickname"
    },
    "IncludeDetails": true
}

The parameters returned from the service are as follows:

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

JSON

{
    "ErrorCode": 4,
    "Result": false,
    "Message": "Card already exists",
    "Body": {
        "Scope": 0,
        "Name": "Test Card",
        "CardBin": "55287900",
        "CardLastFour": "0008",
        "CardHolderName": "Kart Sahibi İsmi",
        "CardNumber": "55287900****0008",
        "Expired": false,
        "CardTypeId": 1,
        "CardType": "Credit",
        "Month": 12,
        "Year": 2030,
        "UniqueCode": "ZtuCwuJWMD+Jqju+ZRnw/X92WNSqFEo97slEjPZD6+5M40L75cT4+g==",
        "Details": {
            "CardBankId": 55,
            "CardBank": "T.HALK BANKASI A.Ş.",
            "CardBrandId": 1,
            "CardBrand": "Master Card",
            "CardFamilyId": 5,
            "CardFamily": "Paraf",
            "CardKindId": 1,
            "CardKind": "Bireysel Kart",
            "CardTypeId": 1,
            "CardType": "Credit"
        }
    }
}