Update a Card Registration

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

CardRegistrationId

string

required

The unique identifier of the Card Registration object.

Body parameters

RegistrationData

string

required

The string returned by the tokenization server on the POST Tokenize the card endpoint.

CardHolderName

string

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.

Responses

string

The unique identifier of the Card Registration object.

Tag

string

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.

CreationDate

timestamp

The date and time at which the object was created.

UserId

string

The unique identifier of the user the card belongs to.

AccessKey

string

The secure value to use when tokenizing the card via the dedicated endpoint.

PreregistrationData

string

The secure value to identify the registration when tokenizing the card via the dedicated endpoint.

RegistrationData

string

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.

CardId

string

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

CardType

string

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.

CardRegistrationURL

string

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.

ResultCode

string

The code indicating the result of the operation. This information is mostly used to handle errors or for filtering purposes.

ResultMessage

string

The explanation of the result code.

Currency

string

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.

Status

string

Returned values: CREATED, VALIDATED, ERROR

The status of the card registration:

CREATED – The card registration has been created, but no RegistrationData has been entered yet and the CardId value is null.
VALIDATED – The card registration has been successfully updated with the RegistrationData from the tokenization server.
ERROR – The card registration couldn’t be updated with the RegistrationData and no CardId was generated. For more information, refer to the ResultCode (105206, 105299) and ResultMessage.

string

The unique identifier of the Card Registration object.

Tag

string

CreationDate

timestamp

The date and time at which the object was created.

UserId

string

The unique identifier of the user the card belongs to.

AccessKey

string

The secure value to use when tokenizing the card via the dedicated endpoint.

PreregistrationData

string

The secure value to identify the registration when tokenizing the card via the dedicated endpoint.

RegistrationData

string

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.

CardId

string

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

CardType

string

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.

CardRegistrationURL

string

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.

ResultCode

string

The code indicating the result of the operation. This information is mostly used to handle errors or for filtering purposes.

ResultMessage

string

The explanation of the result code.

Currency

string

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.

Status

string

Returned values: CREATED, VALIDATED, ERROR

The status of the card registration:

CREATED – The card registration has been created, but no RegistrationData has been entered yet and the CardId value is null.
VALIDATED – The card registration has been successfully updated with the RegistrationData from the tokenization server.
ERROR – The card registration couldn’t be updated with the RegistrationData and no CardId was generated. For more information, refer to the ResultCode (105206, 105299) and ResultMessage.

{
    "Message": "One or several required parameters are missing or incorrect. An incorrect resource ID also raises this kind of error.",
    "Type": "param_error",
    "Id": "a241d282-377f-4415-ab81-5dc11c63f972",
    "Date": 1723543647.0,
    "errors": {
        "CardHolderName": "The field CardHolderName must be between 2 and 255 characters long."
    }
}

Overview

User management

User verification

Wallets

Cards

Card pay-ins

Banking pay-ins

APM pay-ins

Transfers

Refunds

Disputes

Payouts

FX conversions

Transactions

Helpers

Platform account

Update a Card Registration

Path parameters

Body parameters

Responses

Overview

User management

User verification

Wallets

Cards

Card pay-ins

Banking pay-ins

APM pay-ins

Transfers

Refunds

Disputes

Payouts

FX conversions

Transactions

Helpers

Platform account

​Path parameters

​Body parameters

​Responses

Path parameters

Body parameters

Responses