The Card object
Description
The Card object is the virtual and secured version (i.e., the tokenized version) of a card that can be used to make a payment.
The card object is created upon successfully completing the card registration process. The same actual card can be registered several times for security and privacy purposes. As a consequence, for a single real-life card, multiple Card objects can be created in the Mangopay environment.
Caution – Card validation within 24 hours
A successful transaction (preauthorization, pay-in, or recurring) or card validation within 24 hours of the card registration is required to validate a card. Otherwise, the card becomes invalid and a new card registration will be necessary.
Attributes
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.
The unique identifier of the User (natural or legal) who owns the bank account.
Max length: 128 characters (see data formats for details)
The unique identifier of the object.
Max. length: 255 characters
Custom data that you can add to this object.
Unix timestamp (UTC) of the date and time the object was created.
Min. length: 2 characters; 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.
The CardHolderName is not returned in the Card Registration object; it is added to the Card object.