Skip to main content
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, in which case attempting to edit it with this endpoint returns an error.
Warning – Implement card deactivationBecause 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 APIThe 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
string
Format: “MMYY”The expiration date of the card.
​
Alias
string
The card number, partially obfuscated.
​
CardType
string
Returned values: CB_VISA_MASTERCARD, AMEX, MAESTRO, BCMCDefault value: CB_VISA_MASTERCARDThe type of the card. If not supplied, the default value will be taken into account.
​
CardProvider
string
Allowed values: CB, VISA, MASTERCARD, AMEX, MAESTRO, BCMC, JCB, DISCOVERThe provider of the card.
​
Country
string
Format: ISO-3166-1 alpha-3 three-letter country code (e.g., “FRA”)The country of the card (which is the same as the country of the issuer).
​
Product
string
The product type of the card. You can find the list of products in the Card products article (coming soon).
​
BankCode
string
The name of the card issuing bank.
​
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.
​
Currency
string
Returned values: The three-letter ISO 4217 code (EUR, GBP, etc.) of a supported currency (depends on feature, contract, and activation settings).The currency of the card.
​
Validity
string
Returned values: UNKNOWN, VALID, INVALIDWhether the card is valid or not.
  • UNKNOWN – No payment or card validation has been processed, so the validity of the card remains unknown.
  • VALID – The first payment or card validation using the card was processed successfully within 24 hours of the initial card registration.
  • INVALID – The first payment or card validation using the card was attempted and failed, or the status of the corresponding card registration was CREATED for more than 24 hours.
    Once a card is set to INVALID, it cannot be set back to VALID. A new card registration will be necessary to make a payment.
​
UserId
string
The unique identifier of the user the card belongs to.
​
Id
string
The unique identifier of the Card object.
​
Tag
string
Custom data added to this object.
In the case of the Card object, the tag value is inherited from the Card Registration object and is not editable.
​
Fingerprint
string
The unique representation of the card number. This string can be used to track the card behavior while keeping the card information confidential.
​
CardHolderName
string
Max. length: 45 charactersThe cardholder’s name shown on the payment card. This value is passed to the card network for use in transaction risk analysis.
{
    "Message": "The card has already been deactivated",
    "Type": "card_already_not_active",
    "Id": "8ebd2256-e596-4404-8c76-cd14b505d7a4",
    "Date": 1690292341.0,
    "errors": null
}  

{
    "Message": "One or several required parameters are missing or incorrect. An incorrect resource ID also raises this kind of error.",
    "Type": "param_error",
    "Id": "b89e7138-7812-486e-be79-ee817e4441ac#1718650010",
    "Date": 1718650011,
    "errors": {
        "cardHolderName": "card holder name already exists"
    }
}

{
    "Message": "One or several required parameters are missing or incorrect. An incorrect resource ID also raises this kind of error.",
    "Type": "param_error",
    "Id": "e92e4d2a-81fc-4ca6-9a2b-4b3a0cba57e9",
    "Date": 1723036573.0,
    "errors": {
        "CardHolderName": "The field CardHolderName must be between 2 and 255 characters long."
    }
}

{
    "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
}