PUT
/
v2.01
/
{ClientId}
/
cards
/
{CardId}
{
    "Active": false
}  

{
    "ExpirationDate": "1229",
    "Alias": "497010XXXXXX8183",
    "CardType": "CB_VISA_MASTERCARD",
    "CardProvider": "VISA",
    "Country": "FRA",
    "Product": "I",
    "BankCode": "unknown",
    "Active": true,
    "Currency": "EUR",
    "Validity": "VALID",
    "UserId": "user_m_01HZSK5MX04KS9Q7SQSSRGQQ4Q",
    "Id": "card_m_01J0KPBMM32MMSET50CZZ3RMVJ",
    "Tag": null,
    "CreationDate": 1718647902,
    "Fingerprint": "48d63bbcfc2c47fcbc19df35e47b2f8d",
    "CardHolderName": "ALEX SMITH"
}

This call serves one of two purposes:

  • Setting the card as inactive, and thereby disabling it from being used again. This action is irreversible but doesn’t prevent the card being registered again with POST Create a Card Registration.
  • Adding the CardHolderName to an existing Card object. The CardHolderName cannot be modified once added to a Card object. It can also be done during registration with PUT Update a Card Registration.

Warning – Implement card deactivation

Because card information cannot be kept without the end user’s approval, you should implement a way to deactivate the end user’s card systematically when relevant.

​
Path parameters

​
CardId
string
required

The unique identifier of the Card object, which is returned after updating the Card Registration object with the RegistrationData.

​
Body parameters

​
Active
boolean

Whether the card is active or not. Setting this parameter to false is irreversible and should be done once the pay-in is successful.

​
CardHolderName
string

Max. length: 45 characters passed to card network, 255 accepted by the API

The cardholder’s name shown on the payment card. This value is passed to the card network for use in transaction risk analysis.

The value should only contain unmarked alphabetic characters (A-Z, a-z), hyphens (-), apostrophes (‘), and spaces. Letters with diacritics (e.g. É, Ü, ẞ), honorifics (e.g. MRS.) and other special characters are not recommended (they are transformed before being sent to the card network).

The CardHolderName is not returned in the Card Registration object; it is added to the Card object.

​
Responses

{
    "ExpirationDate": "1229",
    "Alias": "497010XXXXXX8183",
    "CardType": "CB_VISA_MASTERCARD",
    "CardProvider": "VISA",
    "Country": "FRA",
    "Product": "I",
    "BankCode": "unknown",
    "Active": true,
    "Currency": "EUR",
    "Validity": "VALID",
    "UserId": "user_m_01HZSK5MX04KS9Q7SQSSRGQQ4Q",
    "Id": "card_m_01J0KPBMM32MMSET50CZZ3RMVJ",
    "Tag": null,
    "CreationDate": 1718647902,
    "Fingerprint": "48d63bbcfc2c47fcbc19df35e47b2f8d",
    "CardHolderName": "ALEX SMITH"
}

{
    "Active": false
}