Sign in

v2

latestOpenAPI 3.1.02026-07-262279731.3 MB
Cards

Deactivate or edit a Card

<Warning icon="fa-regular fa-triangle-exclamation"> **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.
</Warning>

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 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.
put/v2.01/{ClientId}/cards/{CardId}

Path parameters

ClientIdstring required

Platform's API account identifier, associated with the API key.

CardIdstring required

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

Headers

Authorizationstring required

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.

Request body

Activeboolean

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

CardHolderNamestring

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

Success

ExpirationDatestring

Format: “MMYY”

The expiration date of the card.

Aliasstring

The card number, partially obfuscated.

CardTypestring

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.

CardProviderstring

Allowed values: CB, VISA, MASTERCARD, AMEX, MAESTRO, BCMC, JCB, DISCOVER

The provider of the card.

Countrystring

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).

Productstring

The product type of the card.

BankCodestring

The name of the card issuing bank.

Activeboolean

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

Currencystring

Returned values: The three-letter <a href="/api-reference/overview/data-formats" target="_blank">ISO 4217 code</a> (EUR, GBP, etc.) of a <a href="/guides/currencies" target="_blank">supported currency</a> (depends on feature, contract, and activation settings).

The currency of the card.

Validitystring

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 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.
UserIdstring

The unique identifier of the user the card belongs to.

Idstring

Max length: 128 characters (see data formats for details)

The unique identifier of the object.

Tagstring

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.

Fingerprintstring

The unique representation of the card number. This string can be used to track the card behavior while keeping the card information confidential.

CardHolderNamestring

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.