Prerequisites
To support BIN Detection, you must complete a full integration of Cardinal Consumer Authentication.
Completed Getting Started
Complete Cardinal Cruise Standard or Cardinal Cruise Hybrid integration
Implementation Styles
The Cardinal Cruise integration supports multiple ways to add BIN Detection to your web application. You may choose which ever method fits best into your own work flow.
Style 1 - Field Decorator
This implementation is the simplest and recommended approach and requires the least amount of work to complete. Simply add a new attribute to the input field to identify which field it maps to within the Order Object. The credit card number is mapped to the AccountNumber field, so for bin detection we would pass AccountNumber to the attibute data-cardinal-field as seen below:
| Info |
|---|
This style will handle all the heavy lifting for you. You do not need to do any additional work beyond identifying which field is the AccountNumber field. |
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<input type="text" data-cardinal-field="AccountNumber" id="creditCardNumber" name="creditCardNumber" /> |
This will attach an event listener to the element that will update the bin as the consumer types it in. The BIN value will update automatically if they change cards or need to correct an entry.
Style 2 - Event Based
A. Event Based - bin.process
The bin.process event is the recommended event base profiling which allows the merchant or integrator to initiate the device profiling wherever they prefer is the best point in their purchase flow to initiate profiling. The merchant will need to provide a minimum of the first 9 (e.g. BIN) up to the full card number of the consumer (e.g. max of 19 digits). The more digits of the card number provided the better chances of matching if there is a corresponding EMV 3DS Method URL.
| Note | ||
|---|---|---|
| ||
You may have to trigger the bin events more than once if the end user is able to change their card number at the point where Songbird is integrated. Songbird will only profile any given bin a single time, once profiling is completed Songbird will return a success status. Be sure that bin profiling is completed on the card number that is eventually used to checkout with. If less than 9 digits is provided to this event, the event will be resolved successfully, but no profiling will actually take place. The event will resolve when bin profiling was successful or failed with a JSON object describing the outcome. |
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
Cardinal.trigger("bin.process", '1234567894561237'); |
| Info | ||
|---|---|---|
| ||
Checkout the 'bin.process' documentation for more information on this event. |
B. Event Based - accountNumber.update
The accountNumber.update event allows the merchant or integrator to initiate the device profiling when there is an update to the account number that will be used to make the purchase. The merchant will need to provide the full account number between the standard credit card number range of 13-19 digits. For example, in a card-on-file use case, the accountNumber.update could be called when the card number that is being used to make the purchase changes. This allows the merchant to collect the credit card number themselves, then only call this event when there is an update to this value. When the accountNumber.update event is called, Songbird will update the in memory cached order object to include the new card number.
| Note | ||
|---|---|---|
| ||
Pushing changes after If less than 9 digits is provided to this event, the event will be resolved successfully, but no profiling will actually take place. The event will resolve when bin profiling was successful or failed with a JSON object describing the outcome. |
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
Cardinal.trigger("accountNumber.update", '123456789'); |
| Info | ||
|---|---|---|
| ||
Checkout the 'accountNumber.update' documentation for more information on this event. |
Style 3 - Configuration Based
If you already have the credit card number and just need to pass it to Cardinal, you can pass it within an order object as part of the setup object passed in on Cardinal.setup. You can only pass the card number once using this methodology, making it ideal in a flow where the consumer has already entered their payment information. If you do need to update the BIN value, you can pair this implementation with the event based implementation to push updated BINs to Cardinal.
| Info |
|---|
This style will be triggered as soon as the |
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
var orderObject = {
Consumer: {
Account: {
AccountNumber: '1234567894561237'
}
}
};
Cardinal.setup('init', {
jwt: 'ey...',
order: orderObject
}); |