Search…
Online Banking elements
Learn how to use the Online Banking elements.
With DigitalRiver.js, you can create an Online Banking element that will automatically retrieve and build a select dropdown that can be styled and placed on your page like other DigitalRiver.js elements.

Creating an Online Banking element

To create an Online Banking element, use the createElement function exposed through the DigitalRiver Object. This object follows the same pattern and allows for the same custom classes and styles as other elements.
Example
1
var onlineBankingOptions = {
2
classes: {
3
base: "DRElement",
4
complete: "onlineBanking-complete",
5
empty: "onlineBanking-empty",
6
focus: "onlineBanking-focus"
7
},
8
style: {
9
base: {
10
color: '#495057',
11
height: '35px',
12
fontSize: '1rem',
13
fontFamily: 'apple-system,BlinkMacSystemFont,Segoe UI,Roboto,Helvetica Neue,Arial,sans-serif',
14
// fontWeight: 'lighter',
15
':hover': {
16
color: '#ccc',
17
},
18
'::placeholder': {
19
color: '#495057'
20
}
21
},
22
focus: {
23
':hover': {
24
color: '#495057',
25
},
26
},
27
empty: {
28
':hover': {
29
color: '#495057',
30
},
31
},
32
complete: {
33
':hover': {
34
color: '#495057',
35
},
36
}
37
},
38
onlineBanking: {
39
currency: "USD",
40
country: "US"
41
}
42
};
43
44
45
onlineBanking = digitalriverpayments.createElement('onlinebanking', onlineBankingOptions);
Copied!

Online Banking element functions

onlineBanking.mount();

Call this function to place the created Online Banking element on your page.
Example
1
<div id="online-banking"></div>
2
3
onlineBanking.mount('online-banking');
Copied!

onlineBanking.unmount();

Call this function to remove the Online Banking element from your page. The element may be re-added to your page by calling mount().
Example
1
onlineBanking.unmount();
Copied!

onlineBanking.destroy();

Call this function to remove the Online Banking element from your page as well as remove its functionality. You cannot re-add the destroyed element to your page via mount().
Example
1
onlineBanking.destroy();
Copied!

onlineBanking.update();

Call this function to update the Online Banking element's data.
Example
1
let onlineBankingOptions = {
2
classes: {
3
base: "DRElement",
4
complete: "onlineBanking-complete",
5
empty: "onlineBanking-empty",
6
focus: "onlineBanking-focus"
7
},
8
style: {
9
base: {
10
color: '#495057',
11
height: '35px',
12
fontSize: '1rem',
13
fontFamily: 'apple-system,BlinkMacSystemFont,Segoe UI,Roboto,Helvetica Neue,Arial,sans-serif',
14
// fontWeight: 'lighter',
15
':hover': {
16
color: '#ccc',
17
},
18
'::placeholder': {
19
color: '#495057'
20
}
21
},
22
focus: {
23
':hover': {
24
color: '#495057',
25
},
26
},
27
empty: {
28
':hover': {
29
color: '#495057',
30
},
31
},
32
complete: {
33
':hover': {
34
color: '#495057',
35
},
36
}
37
},
38
onlineBanking: {
39
currency: currency,
40
country: country
41
}
42
};
43
44
45
onlineBanking.update(onlineBankingOptions);
Copied!

Online Banking element events — onlineBanking.on('event', handler);

The Online Banking Element can receive the following events by creating an event listener. Use this function to listen to events that can be used to build and enhance your purchase flow.
Event
Triggered When
ready
The created element is loaded and ready to accept an update request.
focus
A shopper clicked the element's button.
blur
The element has lost focus.
change
The element's state has changed.

Ready

The Ready event triggers when the Online Banking Element has loaded and is available to take an update() call.
Example
1
onlineBanking.on('ready', function(event) {
2
//online banking element is ready and can accept an update call
3
});
Copied!
Note: The online banking element ready listener has additional data that you can use to determine whether or not you should show the option to your customer.
In addition to the type of element returned in the ready function, the online banking element returns hasAvailableBanks. This Boolean reflects whether the currency and country combination specified has banks available for payment. If this is false, there are no banks available for payment.
Value
Key
elementType
onlinebanking
hasAvailableBanks
A true or false value signals whether there are banks available for the currency and country combination provided when creating the element.
Response object
1
{
2
elementType: "onlinebanking",
3
hasAvailableBanks: true
4
}
Copied!

Focus

The Focus event triggers when the online banking element has focus.
Example
1
onlineBanking.on('focus', function(event) {
2
//receive the event
3
}
Copied!
Response object
1
{
2
elementType: "onlinebanking"
3
}
Copied!

Blur

The Blur event triggers when the online banking element no longer has focus.
Example
1
onlineBanking.on('blur', function(event) {
2
//receive the event
3
}
Copied!
Response object
1
{
2
elementType: "onlinebanking"
3
}
Copied!

Change

The Change event triggers when the online banking element's state has changed. If you use this element, you will only receive this event when the customer selects a bank.
Example
1
onlineBanking.on('change', function(event) {
2
console.log('online banking change', event);
3
});
Copied!
Response object
1
{
2
complete: true,
3
empty: false,
4
elementType: "onlinebanking",
5
error: null,
6
value: "86"
7
}
Copied!
Key
Value Description
complete
Indicates whether the element is in a complete state.
empty
Indicates whether the element is empty.
elementType
The element type.
error
An error object (if applicable).
value
The value of the selected option.
In this flow, you can now use the createSource method to create a source using the online banking element.
Last modified 2mo ago