Cards
Deactivate or edit a Card
PUT
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
CardHolderNameto an existing Card object. TheCardHolderNamecannot be modified once added to a Card object. It can also be done during registration with PUT Update a Card Registration.
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
The unique identifier of the Card object, which is returned after updating the Card Registration object with the
RegistrationData.Body parameters
Whether the card is active or not. Setting this parameter to
false is irreversible and should be done once the pay-in is successful.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
200
200
Format: “MMYY”The expiration date of the card.
The card number, partially obfuscated.
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.Allowed values:
CB, VISA, MASTERCARD, AMEX, MAESTRO, BCMC, JCB, DISCOVERThe provider of the card.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).
The product type of the card. You can find the list of products in the Card products article (coming soon).
The name of the card issuing bank.
Whether the card is active or not. Setting this parameter to
false is irreversible and should be done once the pay-in is successful.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.
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 wasCREATEDfor more than 24 hours.
Once a card is set toINVALID, it cannot be set back toVALID. A new card registration will be necessary to make a payment.
The unique identifier of the user the card belongs to.
The unique identifier of the Card object.
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.
In the case of the Card object, the tag value is inherited from the Card Registration object and is not editable.
The unique representation of the card number. This string can be used to track the card behavior while keeping the card information confidential.
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.
400 - Card is already deactivated
400 - Card is already deactivated
400 - CardHolderName cannot be modified once added
400 - CardHolderName cannot be modified once added
400 - CardHolderName must be between 2 and 255 characters long
400 - CardHolderName must be between 2 and 255 characters long