1. Add

You can use this service to add a card to the blacklist.

Add Card to Blacklist

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

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

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

Parameter	Type	Compulsory	Description
apikeyprivate	string	Yes	The Private Key you obtained from the merchant panel.
apiclientprivate	string	Yes	The Private Client you 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	It should be used if the cards will be stored in a shared pool within the scope of Partnership management.
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 piece of information to which the card is requested to be linked (all information must be provided during listing).
RelationalId3	string	No	The third unique piece of information to which the card is requested to be linked (all information must be provided during listing).
CardNumber	string	Yes	The card number to be added to the blacklist.
IsSavedCard	bool	Yes/No	It should be sent as true if the process will proceed using a stored card.
UniqueCode	string	Yes/No	It is the identity information of the stored card.

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

JSON

{
    "PartnerBased": false,
    "PartnerIdentity": "e00fee4d-304f-4038-bf25-d31ee53856a9",
    "RelationalId1": "test1111",
    "RelationalId2": null,
    "RelationalId3": null,
    "IsSavedCard": true,
    "UniqueCode": "mfUpwRXYvgxCy2n4aGWT+ygqQ==",
    "CardNumber": ""
}

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.

✅ Successful

{
    "ErrorCode": 0,
    "Result": true,
    "Message": "",
    "Body": {
        "Id": "b49f1ed8-eef7-4215-8bbb-55451fdc03ff"
    }
}

❌ Failed