Create a Card Registration
Create a Card Registration
Read more about the Card Registration object →
Path parameters
Platform's API account identifier, associated with the API key.
Headers
Bearer authentication of the form Bearer <token>, where token is your auth token.
If your platform is using a proxy to take SCA-triggering action on behalf of users, you also need to integrate mTLS authentication and use the api-mtls base URL.
Request body
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 unique identifier of the user the card belongs to.
Allowed 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: The three-letter <a href="/api-reference/overview/data-formats" target="_blank">ISO 4217 code</a> (EUR, GBP, etc.) of a <a href="/guides/currencies" target="_blank">supported currency</a> (depends on feature, contract, and activation settings).
The currency of the card.
Response
Success
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.
Unix timestamp (UTC) of the date and time 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 <a href="/api-reference/card-registrations/update-card-registration">PUT Update a Card Registration</a> 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 <a href="/errors/codes">handle errors</a> or for filtering purposes.
The explanation of the result code.
Returned values: The three-letter <a href="/api-reference/overview/data-formats" target="_blank">ISO 4217 code</a> (EUR, GBP, etc.) of a <a href="/guides/currencies" target="_blank">supported currency</a> (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 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 (<a href="/errors/codes/105206">105206</a>, <a href="/errors/codes/105299">105299</a>) and ResultMessage.