CardsCards

View a Card

View a Card

Authentication

AuthorizationBearer
Bearer authentication of the form `Bearer <token>`, where token is your auth token. If your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.

Path parameters

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

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

Response

Success
ExpirationDatestring

Format: “MMYY”

The expiration date of the card.

Aliasstring
The card number, partially obfuscated.
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.
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.
CreationDateinteger

Unix timestamp (UTC) of the date and time the object was created.

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