Configuring Online Banking (IBP)
Online Banking, also sometimes called Internet Bank Payment (IBP), is a Browser Redirect processing method where customers authorize a debit from their bank account.
Last updated
Was this helpful?
Online Banking, also sometimes called Internet Bank Payment (IBP), is a Browser Redirect processing method where customers authorize a debit from their bank account.
Last updated
Was this helpful?
If you're using, you can create an payment method for your app or website in four easy steps:
Build the Online Banking Source Request Details object. The Online Banking Source Request object requires the following fields.
type
onlineBanking
sessionId
The payment session identifier.
owner
onlineBanking
The Online Banking Details object requires the following fields.
returnUrl
Required
Where you will redirect your customer to after authorization within the Bank authorization experience.
cancelUrl
Required
If you choose to use the full redirect flow, this is where your Customer will be redirected to after cancelling within the Online Banking experience.
bankCode
Required
The identifier of the bank the customer has chosen and will be redirected to when finished. If using the DigitalRiver.js Internet Banking Payment element, this populated for you. If constructing the request yourself, this is a required field.
Choose one of the following options:
To create an Online Banking payment source, use the DigitalRiver.js library to create and mount elements to the HTML container, or you can assemble the information and then send it using the standard calls in DigitalRiver.js.
The Online Banking element creation follows the same pattern as other elements and exposes the same customizations and events. However, to properly display an accurate list of available banks, you must provide an additional onlineBanking
object that holds the country and currency appropriate for your Customer.
onlineBanking.currency
The currency your customer uses to purchase products.
onlineBanking.country
The country where your customer resides.
If you decide not to use the out-of-the-box functionality provided by the Online Banking elements, you can use the digitalriver.retrieveOnlineBankingBanks()
method to build your own experience.
DigitalRiver.js exposes a method that allows you to retrieve the available banks for a country and currency combination. If banks are available, DigitalRiver.js returns an array of objects. If banks are not available, DigitalRiver.js returns an empty array.
You can build an experience suitable for your needs with the retrieved banks.
Once you have reached a point in your flow where the customer has selected a bank, you can use the createSource function to assemble the data and pass it to Digital River to create your payment.
Important: If you create an online banking source without using the DigitalRiver.js online banking element, you must pass an additional field bankCode
.
When you create an Online Banking source, the customer must authorize the charge through their payment provider. You can accomplish this by redirecting the customer to their payment provider.
Use the redirectUrl
parameter in your createSource
response to redirect your customer to the payment provider for authorization.
The payment provider will present the customer with the transaction details where they can authorize or cancel the transaction. A successful authorization redirects the customer to the Online Banking Return URL parameter you specified when you created the source.
Once authorized, the source state will change to chargeable.
An .
An .
To create an online banking source, you must reference the created element and supplemental data in your request to create an online banking source. DigitalRiver.js will retrieve and assemble the request on your behalf.
The address
object must contain postal code and state/province data that using the state
attribute. Note that the state
attribute listed below corresponds to the countrySubdivision
attribute used when providing address information. The payment session manages the correct field name on the backend.
Once authorized, you can use the source by .
See for testing instructions.