The Card Registration object
Register card details to obtain a CardId
token for one-time, recurring, or preauthorized card payments
Description
Mangopay relies on the Card Registration object to safely tokenize a card and create the Card object.
Successfully registering a card to create the Card object is a multiple-step process. It is necessary to process card payments (direct, preauthorized, and recurring card pay-ins) or validate the card.
Note – 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.
Warning – End user approval
Under no circumstances should card information be kept without the end user’s approval. If you don’t have the end user’s approval, you need to deactivate the card.
Best practice – Use Checkout SDK
Simplify payments by card and other payment methods with the Mangopay Checkout SDK.
Attributes
The unique identifier of the Card Registration object.
Custom data that can be added to this object.
In the case of the Card Registration, this parameter can be used to facilitate the link between the User object and its equivalent on your platform for instance. This value will be inherited by the Card object Tag
parameter and will not be editable.
The date and time at which the object was created.
The unique identifier of the user the card belongs to.
The secure value to use when tokenizing the card via the dedicated endpoint.
The secure value to identify the registration when tokenizing the card via the dedicated endpoint.
The string returned by the tokenization server on the POST Tokenize the card endpoint. This string must be sent in full as the RegistrationData
on the PUT Update a Card Registration endpoint to create the Card object.
The unique identifier of the Card object, which is returned after updating the Card Registration object with the RegistrationData
.
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.
The URL to make the card tokenization call.
Caution: This variable URL is specific to each card registration. You must rely on the returned URL in full (host, path, and queries) and not hardcode any part of it.
The code indicating the result of the operation. This information is mostly used to handle errors or for filtering purposes.
The explanation of the result code.
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: CREATED
, VALIDATED
, ERROR
The status of the card registration:
CREATED
– The card registration has been created, but noRegistrationData
has been entered yet and theCardId
value isnull
.VALIDATED
– The card registration has been successfully updated with theRegistrationData
from the tokenization server.ERROR
– The card registration couldn’t be updated with theRegistrationData
and noCardId
was generated. For more information, refer to theResultCode
(105206, 105299) andResultMessage
.
Related resources
Was this page helpful?