Online Banking India Component

Add Online Banking India to an existing Components integration.

Our Online Banking India Component renders Online Banking India in your payment form. As with other redirect payment methods, you need to use createFromAction to redirect the shopper, and handle the redirect after the shopper returns to your website.

Before you begin

This page explains how to add Online Banking India to your existing Web Components integration. The Web Components integration works the same way for all payment methods. If you haven't done this integration yet, refer to our Components integration guide.

Before starting your Online Banking India integration:

Make sure that you have set up your back end implementation, and created an instance of AdyenCheckout.
Add Online Banking India in your Customer Area.

Show Online Banking India in your payment form

To present the Online Banking India Component in your payment form:

From your server, make a /paymentMethods request specifying:
- countryCode: IN
- amount.currency: Any supported currency. For example, INR.
Pass the full response from the /paymentMethods call as the paymentMethodsResponse object when creating an instance of the AdyenCheckout.
Add the Online Banking India Component:
a. Create a DOM element for Online Banking India, placing it where you want the form to be rendered:
```
<div id="billdesk-online-container"></div>
```
b. Create an instance of the Online Banking India Component, and mount it. You can also include optional configuration for presenting the list of issuing banks.
```
const billdesk_online = checkout.create('billdesk_online', {
   issuer: "ALB_DIRECT" // // Optional. Set this to an **id** of an Online Banking India issuer to preselect it.
}).mount('#billdesk-online-container');
```
When the shopper selects the payment method, the Component calls the onChange event, or the onSubmit event if you're using the Pay button. The event contains a state.data object including the shopper's selected payment option. If your integration is set up correctly, the state.data is passed on to your server.

Make a payment

From your server, make a POST /payments request, specifying:

paymentMethod: The state.data.paymentMethod from the onChange or onSubmit event from your front end.
returnUrl: The URL where the shopper will be redirected back to after completing the payment. The URL should include the protocol: http:// or https://. For example, https://your-company.com/checkout/. You can also include your own additional query parameters, for example, shopper ID or order reference number.

https://docs.adyen.com/payment-methods/online-banking-india/web-component#billdeskonline-web-payments

curl https://checkout-test.adyen.com/v67/payments \
-H "x-API-key: YOUR_X-API-KEY" \
-H "content-type: application/json" \
-d '{
  "merchantAccount":"YOUR_MERCHANT_ACCOUNT",
  "reference":"YOUR_ORDER_NUMBER",
  "amount":{
    "currency":"INR",
    "value":1000
  },
  "{hint:state.data.paymentMethod from onChange onSubmit}paymentMethod{/hint}":{
    "type":"billdesk_online",
    "issuer":"ALB_DIRECT",
  },
  "returnUrl":"https://your-company.com/checkout?shopperOrder=12xy.."
}'

# Set your X-API-KEY with the API key from the Customer Area.
adyen = Adyen::Client.new
adyen.api_key = "YOUR_X-API-KEY"
 
response = adyen.checkout.payments({
  :amount => {
    :currency => "INR",
    :value => 1000
  },
  :reference => "YOUR_ORDER_NUMBER",
  :paymentMethod => {
    :type => "billdesk_online",
    :issuer => "ALB_DIRECT"
  },
  :returnUrl => "https://your-company.com/checkout?shopperOrder=12xy..",
  :merchantAccount => "YOUR_MERCHANT_ACCOUNT"
})

// Set YOUR_X-API-KEY with the API key from the Customer Area.
// Change to Environment.LIVE and add the Live URL prefix when you're ready to accept live payments.
    Client client = new Client("YOUR_X-API-KEY", Environment.TEST);
    Checkout checkout = new Checkout(client);

    PaymentsRequest paymentsRequest = new PaymentsRequest();

    String merchantAccount = "YOUR_MERCHANT_ACCOUNT";
    paymentsRequest.setMerchantAccount(merchantAccount);

    Amount amount = new Amount();
    amount.setCurrency("INR");
    amount.setValue(15000L);
    paymentsRequest.setAmount(amount);

    DefaultPaymentMethodDetails paymentMethodDetails = new DefaultPaymentMethodDetails();
    paymentMethodDetails.setType("billdesk_online");
    paymentMethodDetails.setIssuer("ALB_DIRECT");
    paymentsRequest.setPaymentMethod(paymentMethodDetails);

    paymentsRequest.setReference("YOUR_ORDER_NUMBER");
    paymentsRequest.setReturnUrl("https://your-company.com/checkout?shopperOrder=12xy..");

    PaymentsResponse paymentsResponse = checkout.payments(paymentsRequest);

// Set your X-API-KEY with the API key from the Customer Area.
$client = new \Adyen\Client();
$client->setXApiKey("YOUR_X-API-KEY");
$service = new \Adyen\Service\Checkout($client);

$params = array(
  "amount" => array(
    "currency" => "INR",
    "value" => 1000
  ),
  "reference" => "YOUR_ORDER_NUMBER",
  "paymentMethod" => array(
    "type" => "billdesk_online",
    "issuer" => "ALB_DIRECT"
  ),
  "returnUrl" => "https://your-company.com/checkout?shopperOrder=12xy..",
  "merchantAccount" => "YOUR_MERCHANT_ACCOUNT"
);
$result = $service->payments($params);

#Set your X-API-KEY with the API key from the Customer Area.
adyen = Adyen.Adyen()
adyen.client.xapikey = 'YOUR_X-API-KEY'

result = adyen.checkout.payments({
   'amount': {
      'value': 1000,
      'currency': 'INR'
   },
   'reference': 'YOUR_ORDER_NUMBER',
   'paymentMethod': {
      'type': 'billdesk_online',
      'issuer': 'ALB_DIRECT'
   },
   'returnUrl': 'https://your-company.com/checkout?shopperOrder=12xy..',
   'merchantAccount': 'YOUR_MERCHANT_ACCOUNT'
})

// Set your X-API-KEY with the API key from the Customer Area.
var client = new Client ("YOUR_X-API-KEY", Environment.Test);
var checkout = new Checkout(client);

var amount = new Model.Checkout.Amount("INR", 1000);
var details = new Model.Checkout.DefaultPaymentMethodDetails{
  Type = "billdesk_online",
  Issuer = "ALB_DIRECT"
};
var paymentRequest = new Adyen.Model.Checkout.PaymentRequest
{
  Reference = "YOUR_ORDER_NUMBER",
  Amount = amount,
  ReturnUrl = @"https://your-company.com/checkout?shopperOrder=12xy..",
  MerchantAccount = "YOUR_MERCHANT_ACCOUNT",
  PaymentMethod = details
};

var paymentResponse = checkout.Payments(paymentsRequest);

// Set your X-API-KEY with the API key from the Customer Area.
const {Client, Config, CheckoutAPI} = require('@adyen/api-library');
const config = new Config();
// Set your X-API-KEY with the API key from the Customer Area.
config.apiKey = '[API_KEY]';
config.merchantAccount = '[YOUR_MERCHANT_ACCOUNT]';
const client = new Client({ config });
client.setEnvironment("TEST");
const checkout = new CheckoutAPI(client);
checkout.payments({
    amount: { currency: "INR", value: 1000 },
    paymentMethod: {
        type: 'billdesk_online',
        issuer: 'ALB_DIRECT'
    },
    reference: "YOUR_ORDER_NUMBER",
    merchantAccount: config.merchantAccount,
    returnUrl: "https://your-company.com/checkout?shopperOrder=12xy.."
}).then(res => res);

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

https://docs.adyen.com/payment-methods/afterpaytouch/ios-drop-in#-payments-response

/payments response

{
   "resultCode":"RedirectShopper",
   "action":{
      "paymentMethodType":"billdesk_online",
      "method":"GET",
      "url":"https://checkoutshopper-test.adyen.com/checkoutshopper/checkoutPaymentRedirect?redirectData=...",
      "type":"redirect"
   }
}

If your integration is set up correctly, the action object is passed from your server to the client.

Handle the redirect

Handling the redirect works the same way for all redirect payment methods:

Call createFromAction, passing the action object from the previous step. This will return a new Component that you need to mount:
```
checkout.createFromAction(action).mount('#my-container');
```
The Component redirects the shopper to complete the payment.
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.
https://docs.adyen.com/payment-methods/afterpaytouch/web-component#-payments-details-request
/payments/details request
curl https://checkout-test.adyen.com/v67/payments/details \ -H "x-API-key: YOUR_X-API-KEY" \ -H "content-type: application/json" \ -d '{ "details": { "redirectResult": "eyJ0cmFuc1N0YXR1cyI6IlkifQ==" } }'
The /payments/details response contains:
- resultCode: Use this to present the payment result to your shopper.
- pspReference: Our unique identifier for the transaction.
https://docs.adyen.com/payment-methods/afterpaytouch/web-component#-payments-details-response
/payments/details response
{ "resultCode": "Authorised", "pspReference": "88154795347618C" }

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 Received	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 notification.
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 notification 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.

Are you looking for test card numbers?

Would you like to contact support?