The Card Registration object
You need to register a card in order to process a Direct PayIn. Card registration enables you to tokenize a Card. These are the steps to follow:
- Create a
CardRegistration
Object (1. 2. & 3. in the diagram) - Get the
PreRegistrationData
,CardRegistrationURL
andAccessKey
(4. in the diagram) - The user posts
PreRegistrationData
,AccessKey
andcard details
through a form to theCardRegistrationURL
(5. in the diagram) - Get a
RegistrationData
back (6. in the diagram) - Edit the
CardRegistration
Object with theRegistrationData
just received (7.8. in the diagram) - Get the
CardId
ready to use into the Direct PayIn Object (9. in the diagram)
You need to do your tests in sandbox mode only with the testing cards
If you don’t want to save the card you must change the field ACTIVE in the card object to false as shown here
IMPORTANT: Card details must never pass via your server – therefore you must use the card registration process given below and not implement a different system where the card details may touch your server – (this approach or anything similar) is strictly not allowed
Registration Flow
Here is the registration flow (the last step correponds to the Direct PayIn):
- It is imperative to inform your users if you are registering their cards.
- A successful transaction (preauthorization, pay-in, or recurring) within 24 hours after the card registration is required to validate a
CardId
. Otherwise, the cardValidity
will be set to “INVALID” and a new card registration will be necessary to make a payment.
Parameters
UserId
string:
Maximum length is 255 characters
The object owner's UserId
Currency
CurrencyCard:
AED, AUD, CAD, CHF, DKK, EUR, GBP, HKD, JPY, NOK, PLN, SEK, USD, ZAR
The currency of the card - should be ISO_4217 format
AccessKey
string:
Maximum length is 255 characters
A special key to use when registering a card
PreregistrationData
string:
Maximum length is 255 characters
A specific value to pass to the CardRegistrationURL
CardRegistrationURL
string:
Maximum length is 255 characters
The URL to submit the card details form to
RegistrationData
string:
Maximum length is 255 characters
Having registered a card, this confirmation hash needs to be updated to the card item
CardType
CardType:
CB_VISA_MASTERCARD, DINERS, AMEX, MAESTRO, P24, IDEAL, BCMC
The type of Card
The type of card . The card type is optional, but the default parameter is "CB_VISA_MASTERCARD" .
CardId
string:
Maximum length is 255 characters
The ID of a card
ResultCode
string:
Maximum length is 255 characters
The result code
ResultMessage
string:
Maximum length is 255 characters
A verbal explanation of the ResultCode
Status
CardStatus:
CREATED, VALIDATED, ERROR
Status of the card registration