Deactivate or edit a Card
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.
Deactivate or edit a Card
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, in which case attempting to edit it with this endpoint returns an error.
Authentication
Bearer authentication of the form Bearer <token>, where token is your auth token.
If your platform is using a proxy to take SCA-triggering action on behalf of users, you also need to integrate mTLS authentication and use the api-mtls base URL.
Path parameters
The unique identifier of the Card object, which is returned after updating the Card Registration object with the RegistrationData.
Request
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 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.
Response
Format: “MMYY”
The expiration date of the card.
Returned values: CB_VISA_MASTERCARD, AMEX, MAESTRO, BCMC
Default value: CB_VISA_MASTERCARD
The type of the card. If not supplied, the default value will be taken into account.
Allowed values: CB, VISA, MASTERCARD, AMEX, MAESTRO, BCMC, JCB, DISCOVER
The 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).
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, INVALID
Whether 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.
Max length: 128 characters (see data formats for details)
The unique identifier of the object.
Max. length: 255 characters
Custom data added to this object. This value is inherited from the Card Registration object and cannot be edited.
Max. length: 45 characters
The cardholder's name shown on the payment card. This value is passed to the card network for use in transaction risk analysis.