Payment-method icon

Online banking India for API only

Add Online banking India to an existing API-only integration.

Accept Online banking India payments using our APIs, and build your own payment form to have full control over the look and feel of your checkout page.

Before you begin

These instructions explain how to add Online banking India to your existing API-only integration. The API-only integration works the same way for all payment methods. If you haven't done this integration yet, refer to our API-only integration guide.

Before starting your Online banking India integration:

  1. Make sure that you have set up your back end implementation with Checkout API v68 or later.
  2. Add Online banking India in your test Customer Area.

Build your payment form for Online banking India

To show Online banking India in your payment form, you need to:

  1. Show Online banking India as an available payment method.
  2. Show a list of available banks to your shopper.
  3. After the shopper selects a bank, pass the corresponding issuer value to your server. You'll need this to make a payment. Make a /paymentMethods call to obtain the complete list of issuers for Online banking India. For example, if the shopper selects Central Bank of India, pass the value CBI.

We provide an Online banking India logo that you can use on your payment form. For more information, refer to Downloading logos.

We recommend you do not use a hardcoded form, because the list of issuers for Online banking India is long and changes relatively often, and not all issuers are online all the time.

Because of the large number of small issuers, we recommend you use a dynamically generated form showing the top 10 issuers, and an option to show more issuers if the shopper's bank is not listed.

If you are using the /paymentMethods to show available payment methods to the shopper, specify the following:

The list of issuing banks and IDs is included in the object with paymentMethod.type: onlinebanking_IN.

Make a payment

In your /payments request, specify:

  • paymentMethod.type: onlinebanking_IN
  • paymentMethod.issuer: The issuer ID of the shopper's selected bank.

The /payments response contains an action object with the information needed to redirect the shopper.

Handle the redirect

  1. To complete the payment, redirect the shopper to the action.url returned in the /payments response.

When using the HTTP GET method:
For security reasons, when displaying the redirect in the app, we recommend that you use SFSafariViewController for iOS or Chrome Custom Tabs for Android, instead of WebView objects. Also refer to the security best practices for WebView.

  1. After the shopper is redirected back to your website, check the payment result by making a POST /payments/details request, specifying:

    • details: Object that contains the URL-decoded redirectResult returned when the shopper was redirected back to your site.

You receive a response containing:

  • resultCode: Use this to present the result to your shopper.
  • pspReference: Our unique identifier for the transaction.

Present the payment result

Use the  resultCode that you received in the /payments/details response to present the payment result to your shopper.

The resultCode values you can receive for Online banking India are:

resultCode Description Action to take
Authorised The payment was successful. Inform the shopper that the payment has been successful.
You will receive the funds in 3 days.
Cancelled The shopper canceled the payment while on the checkout page. Ask the shopper whether they want to continue with the order, or ask them to select a different payment method.
Pending or
The shopper has completed the payment but the final result is not yet known. Inform the shopper that you've received their order, and are waiting for the payment to be completed.
To know the final result of the payment, wait for the AUTHORISATION webhook.
Refused The payment was refused by the shopper's bank. Ask the shopper to try the payment again using a different payment method.

If the shopper failed to return to your website or app, wait for webhooks to know the outcome of the payment:

eventCode success field Description Action to take
AUTHORISATION false The transaction failed. Cancel the order and inform the shopper that the payment failed.
AUTHORISATION true The shopper successfully completed the payment. Inform the shopper that the payment has been successful and proceed with the order.

Test and go live

Online banking India currently has no test platform.

Before you can accept live Online banking India payments, you need to submit a request for Online banking India in your live Customer Area.

See also