Card registrations
Update a Card Registration
PUT
This call is used to add the string acquired from the tokenization to the Card Registration object in the parameter
RegistrationData, thereby validating the registration.
As a result, the Card object is created and the corresponding CardId returned.
Platforms should also send the cardholder’s name as it appears on the payment card. The CardHolderName parameter is sent on this call but not returned in the response; it is added to the Card object.
Path parameters
The unique identifier of the Card Registration object.
Body parameters
The string returned by the tokenization server on the POST Tokenize the card endpoint.
Min. length: 2 characters; max. length: 45 characters passed to card network, 255 accepted by the APIThe 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.Responses
200 - Status "VALIDATED"
200 - Status "VALIDATED"
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
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, which 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, BCMCDefault value: CB_VISA_MASTERCARDThe 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, ERRORThe status of the card registration:CREATED– The card registration has been created, but noRegistrationDatahas been entered yet and theCardIdvalue isnull.VALIDATED– The card registration has been successfully updated with theRegistrationDatafrom the tokenization server.ERROR– The card registration couldn’t be updated with theRegistrationDataand noCardIdwas generated. For more information, refer to theResultCode(105206, 105299) andResultMessage.
200 - Status "ERROR"
200 - Status "ERROR"
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
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, which 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, BCMCDefault value: CB_VISA_MASTERCARDThe 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, ERRORThe status of the card registration:CREATED– The card registration has been created, but noRegistrationDatahas been entered yet and theCardIdvalue isnull.VALIDATED– The card registration has been successfully updated with theRegistrationDatafrom the tokenization server.ERROR– The card registration couldn’t be updated with theRegistrationDataand noCardIdwas generated. For more information, refer to theResultCode(105206, 105299) andResultMessage.
400 - CardHolderName can't be longer than than 255 characters
400 - CardHolderName can't be longer than than 255 characters