Purchase

When performing a purchase, the customer is redirected to the provider service where they make a purchase.

Countries and regions India
Payment currencies INR
Payment amount limits Contact your key account manager at Monetix for details. Also you can check the payment amount limits in your project by using Dashboard.
Payment processing time Contact your key account manager at Monetix for details.
Currency conversion On the Monetix side
Refund
Onboarding and access fee Contact your key account manager at Monetix for details.
Special considerations

Cascading payment processing is supported for operations by using Payment Page for this method. For information, see Payment Cascading or contact your Monetix supporting manager.

Operations support

Interfaces
Payment Page Gate Dashboard
Purchase
Refund

You can check the payment amount limits in your project by using Dashboard. To check your payment amount limits, go to Dashboard, select the Projects section, and then click the Payment methods tab.

The following sections provide more information about the payment processing flow and the analysis of completed payments.

Purchase by using Payment Page

General information

To perform a purchase by using Payment Page with the Banks of India payment method:

  1. Send a request with all the required parameters and signature to the Monetix URL.
  2. Accept the callback with the purchase result from the payment platform.

The following figure shows the complete purchase processing flow in the Banks of India payment method.

Figure 1. Purchase processing steps for a purchase by using Payment Page
  1. The customer initiates a purchase in your system.
  2. Your system sends the request for the purchase through Payment Page to the Monetix URL.
  3. The checkout page is displayed to the customer.
  4. The customer chooses to make a purchase with the Banks of India payment method.
  5. The payment platform processes the request and forwards it to the provider service.
  6. The provider service sends the customer redirection data to the payment platform.
  7. The checkout page redirects the customer to the provider service.
  8. The customer completes the purchase.
  9. The customer is redirected back to the checkout page.
  10. The provider service sends the purchase result information to the payment platform.
  11. The payment platform sends a callback with the payment result to your system.
  12. The payment platform displays the payment result to the customer on the checkout page.

Request

The following table lists the parameters that you need to include in the request for purchase through the checkout page with the Banks of India payment method.

Table 1. Basic parameters of requests to Payment Page

strictly required—the parameter must be in the initial request.

required—the parameter is required for purchase processing but using it in the initial request is optional. If you don't specify this parameter in your request, the checkout page will contain an additional field for the customer to enter the missing information. For more information on how to act in such cases, see Submission of additional payment information.

optional—the parameter is optional but adding it to the request either makes the payment process more customer-friendly or helps to increase the percentage of successful payments.

✱—the parameter may not be required in some cases. Contact your account manager at Monetix for details.
ParameterDescription

project_id
integer
strictly required

Project ID you obtained from Monetix when integrating.

Example: 1234

payment_id
string
strictly required

Payment ID unique within your project.

Example: payment_47

customer_id
string
strictly required

Unique ID of the customer within your project.

Example: customer_123

customer_first_name
string
strictly required

Customer's first name.

Example: John

customer_last_name
string
strictly required

Customer's last name.

Example: Doe

customer_email
string
strictly required

Customer's email.

Example: johndoe@example.com

customer_phone
string
required✱

Customer phone number, consisting of 10 digits or 12 digits—if the number includes the country code of India (91). If you do not submit this parameter in the initial request, the payment platform will request this parameter by sending to the web service a callback with a list of the parameters web service is required to submit (for more information about this procedure, see Submission of additional payment information). If the web service submits all the required parameters in the initial request, the payment platform will not issue such a callback. Consult your Monetix key account manager to find out whether this parameter is required.

Example: 910123456789

payment_currency
string
strictly required

Code of the payment currency in the ISO-4217 alpha-3 format.

Example: INR

payment_amount
integer
strictly required

Payment amount in minor currency units without any decimal point or comma except for the cases when the currency doesn't have any minor currency units.

If the currency doesn't have any minor units (i.e. the number of digits for minor currency units is zero), set this parameter to the amount in the major currency units. To check whether the currency has any minor units, see Currency codes.

Example: 100.00 INR must be sent as 10000

force_payment_method
string
optional

Parameter that allows you to enforce the Banks of India payment method for your customer and skip the page with payment method selections.

To enforce the Banks of India payment method and skip the page with payment method selection, add the force_payment_method parameter to the request and set its value to online-indian-banks. For more information about enforcing payment methods, see Preselecting payment methods.

Example: force_payment_method: 'online-indian-banks'

signature
string
strictly required

Signature created after you've specified all the request parameters. For more information about signature generation, see Signature generation and verification.
You can also add any other optional parameters to the request, if necessary. For the list of all the parameters possible in requests to Payment Page, see Payment Page invocation parameters.

Here is an example of the data from a request to open the checkout page by using EPayWidget:

EPayWidget.run(
	{
		project_id: 1234,
		payment_id: 'payment_47',
		customer_id: 'customer_123',
		customer_first_name: 'John',
		customer_last_name: 'Doe',
		customer_email: 'johndoe@example.com',
		customer_phone: '910123456789',
		payment_currency: 'INR',
		payment_amount: 10000,
		force_payment_method: 'online-indian-banks',
		signature: 'kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KU+Y19vySO/RLUkDJrOcZzUCwX6R/ekpZhkIQg=='
	}
)

Displaying bank icons on the checkout page

In the Banks of India payment method, the payments are performed through specific banks. When making a purchase on the checkout page, the customer first chooses a payment method and then selects the bank.

The Banks of India payment method offers several options to display bank icons on the checkout page:

  • Choosing the bank in two steps First, the customer chooses Banks of India among other payment methods, and then selects the bank from the list. This is the default behavior.
  • Displaying banks alongside other payment methods To display banks as separate buttons on the checkout page alongside the other payment methods, add the payment_methods_options object with the split_banks parameter to the request and set the value of this parameter to true.

    Here is an example of the payment_methods_options object from the link to open the checkout page:

    payment_methods_options={"online_indian_banks": {"split_banks": true}}
  • Displaying only banks of the Banks of India payment method For the customer to see only banks available in the Banks of India payment method (without other payment methods), add the force_payment_method parameter to the request and set it to online-indian-banks.
  • Displaying only specific banks To show the customer only specific banks available in the Banks of India payment method, use the force_payment_method parameter with the online-indian-banks value in the request, add the payment_methods_options object with the split_banks parameter and set this parameter to true. Next, specify the IDs of the banks to display in the banks_id array.

    Here is an example of the payment_methods_options object from the link to open the checkout page:

    payment_methods_options={"online_indian_banks": {"split_banks": true, "banks_id": [140, 141]}}

    Here is an example of the data from a request with preselected banks to open the checkout page with EPayWidget.

    Figure 2. Example of the data from a request to open the checkout page with preselected banks
    EPayWidget.run(
    {
        project_id: 1234,
        payment_id: 'payment_47',
        customer_id: 'customer_123',
        customer_first_name: 'John',
        customer_last_name: 'Doe',
        customer_email: 'johndoe@example.com',
        payment_currency: 'INR',
        payment_amount: 10000,
        force_payment_method: 'online-indian-banks',
        payment_methods_options: '{"online_indian_banks": {"banks_id": [140, 141]}}',
        signature: 'kUi2x9dKHA5VNU0FY...vySO2RLCv1htT4DqtVUkDJrOcZzUCwX6Re1kpZhkIQg=='
    }
)
  • Enforcing only one bank If you want the customer to go directly to their bank service to complete the payment (without choosing a payment method and bank on the checkout page), use the force_payment_method parameter with the online-indian-banks value in the request, add the payment_methods_options object with the split_banks parameter and set the value of this parameter to true. Next, specify the ID of the required bank in the banks_id array.

    Here is an example of the payment_methods_options object from the link to open the checkout page:

    payment_methods_options={"online_indian_banks": {"split_banks": true, "banks_id": [140]}}

    Here is an example of the data from a request to open the checkout page with one preselected bank by using EPayWidget.

    Figure 3. Example of the data from a request to open the checkout page with one preselected bank
    EPayWidget.run(
    {
        project_id: 1234,
        payment_id: 'payment_47',
        customer_id: 'customer_123',
        customer_first_name: 'John',
        customer_last_name: 'Doe',
        customer_email: 'johndoe@example.com',
        payment_currency: 'INR',
        payment_amount: 10000,
        force_payment_method: 'online-indian-banks',
        payment_methods_options: '{"online_indian_banks": {"banks_id": [140]}}',
        signature: 'kUi2x9dKHA5VNU0FY...vySO/RLCv1htT4DqtVUkDJrOcZzUCwX6Rek7pZhkIQg=='
    }
)

Bank IDs to be passed in the banks_id parameter

Bank IDs that you can pass in the banks_id parameter to display the icons of specific banks on the checkout page are listed in the corresponding section Banks available for purchase.

Callback

In the Banks of India payment method, the payment platform returns the purchase result in a callback. For the information about the callback structure, see Callbacks in Payment Page.

The following is an example of a callback body with information about a successfully completed purchase.

Figure 4. Example of the data from a successful purchase callback
{
    "project_id": 1234,
    "payment": {
        "id": "payment_47",
        "type": "purchase",
        "status": "success",
        "date": "2024-12-07T19:08:45+0000",
        "method": "India banks",
        "sum": {
            "amount": 10000,
            "currency": "INR"
        },
        "description": ""
    },
    "customer": {
        "id": "customer_123"
    },
    "operation": {
        "id": 47,
        "type": "sale",
        "status": "success",
        "date": "2024-12-07T19:08:45+0000",
        "created_date": "2024-12-07T19:08:05+0000",
        "request_id": "1a23456bc7890de",
        "sum_initial": {
            "amount": 10000,
            "currency": "INR"
        },
        "sum_converted": {
            "amount": 10000,
            "currency": "INR"
        },
        "code": "0",
        "message": "Success",
        "provider": {
            "id": 12345,
            "payment_id": "123abc123-123",
            "auth_code": ""
        }
    },
    "signature": "U7HQO7ToISZhMPKdM4XrUKQtoYzFvoB3cs9CRd4xeYG2Q=="
}

The following is an example of a callback for a declined purchase.

Figure 5. Example of the data from a declined purchase callback
{
    "project_id": 1234,
    "payment": {
        "id": "payment_47",
        "type": "purchase",
        "status": "decline",
        "date": "2024-12-07T19:08:45+0000",
        "method": "India banks",
        "sum": {
            "amount": 10000,
            "currency": "INR"
        },
        "description": ""
    },
    "customer": {
        "id": "customer_123"
    },
    "operation": {
        "id": 47,
        "type": "sale",
        "status": "decline",
        "date": "2024-12-07T19:08:45+0000",
        "created_date": "2024-12-07T19:08:05+0000",
        "request_id": "1a23456bc7890de",
        "sum_initial": {
            "amount": 10000,
            "currency": "INR"
        },
        "sum_converted": {
            "amount": 10000,
            "currency": "INR"
        },
        "code": "20000",
        "message": "General decline",
        "provider": {
            "id": 12345,
            "payment_id": "123abc123-123",
            "auth_code": ""
        }
    },
    "signature": "U7HQO7ToISZhMPKdM4XrUKQtoYzFvoB3cs9CRd4xeYG2Q=="
}

Related topics

Purchase by using Gate

General information

To perform a purchase by using Gate with the Banks of India payment method:

  1. Send a request with all the required parameters and signature to the Monetix URL.
  2. Redirect the customer to the provider service.
  3. Accept the callback with the purchase result from the payment platform.

The following figure provides the details of the purchase processing flow in the Banks of India payment method.

Figure 6. Purchase processing flow when performing a purchase by using Gate
  1. The customer initiates a purchase in your system.
  2. Your system sends the purchase request to the Monetix payment platform.
  3. The payment platform sends you a response in which it acknowledges your request and provides the request validation result. (For more information about the response format, see Response structure.)
  4. The payment platform processes the request and forwards it to the provider service.
  5. The provider service sends the customer redirection data to the payment platform.
  6. The payment platform forwards the data to your system in the redirect_data object.
  7. Your system redirects the customer to the provider service.
  8. The customer completes the purchase.
  9. The customer is redirected to your system.
  10. The provider service informs the payment platform about the purchase result.
  11. The payment platform sends the callback with the payment result to your system.
  12. Your system sends the payment result to the customer.

Request

This section provides the instructions on how to build the request for purchase with the Banks of India payment method.

HTTP request method POST
Request body format JSON
API endpoint/v2/payment/banks/india/sale
Full API endpoint specification /v2/payment/banks/{payment_method}/sale
Table 2. Basic parameters of a purchase request

strictly required—the parameter must be in the initial request.

required—the parameter is required for purchase processing but using it in the initial request is optional. If you omit this parameter from the request, the payment platform will request the parameter by sending your system a callback with the list of all the missing parameters you are required to submit. For more information on how to act in such cases, see Submission of additional payment information.

optional—the parameter is optional but adding it to the request either makes the payment process more customer-friendly or helps to increase the percentage of successful payments.

✱—the parameter may not be required in some cases. Contact your account manager at Monetix for details.
ObjectParameterDescription

general
object
strictly required

project_id
integer
strictly required

Project ID you obtained from Monetix when integrating.

Example: 1234

payment_id
string
strictly required

Payment ID unique within your project.

Example: payment_47

signature
string
strictly required

Signature created after you've specified all the request parameters. For more information about signature generation, see Signature generation and verification.

customer
object
strictly required

id
string
strictly required

Unique ID of the customer within your project.

Example: customer_123

ip_address
string
strictly required

IP address of the customer's device.

Example: 198.51.100.47

first_name
string
strictly required

Customer's first name.

Example: John

last_name
string
strictly required

Customer's last name.

Example: Doe

email
string
strictly required

Customer's email.

Example: johndoe@example.com

phone
string
required✱

Customer phone number, consisting of 10 digits or 12 digits—if the number includes the country code of India (91). If you do not submit this parameter in the initial request, the payment platform will request this parameter by sending to the web service a callback with a list of the parameters web service is required to submit (for more information about this procedure, see Submission of additional payment information). If the web service submits all the required parameters in the initial request, the payment platform will not issue such a callback. Consult your Monetix key account manager to find out whether this parameter is required.

Example: 910123456789

account
object
strictly required

bank_id
string
strictly required

Customer's bank ID. For information on how to get the list of the supported banks IDs, see Banks available for purchase.

Example: 408

payment
object
strictly required

currency
string
strictly required

Code of the payment currency in the ISO-4217 alpha-3 format.

Example: INR

amount
integer
strictly required

Payment amount in minor currency units without any decimal point or comma except for the cases when the currency doesn't have any minor currency units.

If the currency doesn't have any minor units (i.e. the number of digits for minor currency units is zero), set this parameter to the amount in the major currency units. To check whether the currency has any minor units, see Currency codes.

Example: 100.00 INR must be sent as 10000

return_url
object
strictly required

success
string
strictly required

The URL to redirect the customer to after the payment is successfully completed.

Example: https://example.com/success/

decline
string
optional

The URL to redirect the customer to after the payment is declined.

Example: https://example.com/decline/

return
string
strictly required

The URL to redirect the customer to when they prematurely terminate the payment. This URL is also used if the success and decline parameters are not specified in the request. If you don't specify any parameters of the return_url object in the request, by default Gate will redirect the customer to the URL specified in your project in Monetix.

Example: https://example.com/return/

You can also add any other optional parameters to the purchase request, if necessary. For the list of all the parameters available in Gate, see API Reference.

Here is an example of the data from a request to initiate a purchase with the Banks of India payment method:

Figure 7. Example of the purchase request body
{
    "general": {
        "project_id": 1234,
        "payment_id": "payment_47",
        "signature": "kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KU+Y19vySO/RLUkDJrOcZzUCwX6R/ekpZhkIQg=="
    },
    "customer": {
        "id": "customer_123",
        "ip_address": "198.51.100.47",
        "first_name": "John",
        "last_name": "Doe",
        "email": "johndoe@example.com",
        "phone": "910123456789"
    },
    "account": {
        "bank_id": "408"
    },
    "payment": {
        "currency": "INR",
        "amount": 10000
    },
    "return_url": {
        "success": "https://example.com/success/",
        "decline": "https://example.com/decline/",
        "return": "https://example.com/return/"
    }
}

Customer redirection

After receiving and processing your purchase request, the payment platform sends you the callback with the data for redirecting the customer to the provider service.

To redirect the customer, use the values of the following parameters in the redirect_data object:

  • url—the URL to redirect the customer to
  • body—the data to send in the request body
  • method—the HTTP method for retrieving the website page (for example, POST or GET)
  • encrypted—this is the service parameter. Ignore it.

Here is an example of the callback snippet with the data to redirect the customer.

"redirect_data": {
    "method": "POST",
    "body": {
        "example_parameter_1": "value_1",
        "example_parameter_2": "value_2"
    },
    "encrypted": [],
    "url": "https://example.com/redirect"
}

Callback

In the Banks of India payment method, the payment platform returns the purchase result in a callback. For the information about the callback structure, see Callbacks in Gate.

The following is an example of a callback body with the information about a successfully completed purchase.

Figure 8. Example of the data from a successful purchase callback
{
    "project_id": 1234,
    "payment": {
        "id": "payment_47",
        "type": "purchase",
        "status": "success",
        "date": "2024-12-07T19:08:45+0000",
        "method": "India banks",
        "sum": {
            "amount": 10000,
            "currency": "INR"
        },
        "description": ""
    },
    "customer": {
        "id": "customer_123"
    },
    "operation": {
        "id": 47,
        "type": "sale",
        "status": "success",
        "date": "2024-12-07T19:08:45+0000",
        "created_date": "2024-12-07T19:08:05+0000",
        "request_id": "1a23456bc7890de",
        "sum_initial": {
            "amount": 10000,
            "currency": "INR"
        },
        "sum_converted": {
            "amount": 10000,
            "currency": "INR"
        },
        "code": "0",
        "message": "Success",
        "provider": {
            "id": 12345,
            "payment_id": "123abc123-123",
            "auth_code": ""
        }
    },
    "signature": "U7HQO7ToISZhMPKdM4XrUKQtoYzFvoB3cs9CRd4xeYG2Q=="
}

The following is an example of a callback for a declined purchase.

Figure 9. Example of the data from a declined purchase callback
{
    "project_id": 1234,
    "payment": {
        "id": "payment_47",
        "type": "purchase",
        "status": "decline",
        "date": "2024-12-07T19:08:45+0000",
        "method": "India banks",
        "sum": {
            "amount": 10000,
            "currency": "INR"
        },
        "description": ""
    },
    "customer": {
        "id": "customer_123"
    },
    "operation": {
        "id": 47,
        "type": "sale",
        "status": "decline",
        "date": "2024-12-07T19:08:45+0000",
        "created_date": "2024-12-07T19:08:05+0000",
        "request_id": "1a23456bc7890de",
        "sum_initial": {
            "amount": 10000,
            "currency": "INR"
        },
        "sum_converted": {
            "amount": 10000,
            "currency": "INR"
        },
        "code": "20000",
        "message": "General decline",
        "provider": {
            "id": 12345,
            "payment_id": "123abc123-123",
            "auth_code": ""
        }
    },
    "signature": "U7HQO7ToISZhMPKdM4XrUKQtoYzFvoB3cs9CRd4xeYG2Q=="
}

Related topics

Refund by using Gate

General information

To perform a refund by using Gate for a purchase made with the Banks of India payment method:

  1. Send a request with all the required parameters and signature to the Monetix URL.
  2. Accept the callback with the refund result from the payment platform.

The following picture provides all the details of the refund processing flow in the Banks of India payment method.

Figure 10. Refund processing flow when performing a refund by using Gate
  1. The customer initiates a refund in your system.
  2. Your system sends the refund request to the Monetix payment platform.
  3. The payment platform sends you a response in which it acknowledges your request and provides the request validation result. (For more information about the response format, see Response structure.)
  4. The payment platform processes the request and forwards it to the provider service.
  5. The provider service informs the payment platform about the refund result.
  6. The payment platform sends you the callback with the refund result.
  7. Your system sends the refund result to the customer.

Request

This section provides the instructions on how to build the request for refund with the Banks of India payment method.

HTTP request method POST
Request body format JSON
API endpoint/v2/payment/banks/india/refund
Full API endpoint specification /v2/payment/banks/{payment_method}/refund
Table 3. Basic parameters of a refund request

strictly required—the parameter must be in the initial request.

optional—the parameter is optional but adding it to the request either makes the payment process more customer-friendly or helps to increase the percentage of successful payments.
ObjectParameterDescription

general
object
strictly required

project_id
integer
strictly required

Project ID you obtained from Monetix when integrating.

Example: 1234

payment_id
string
strictly required

ID of the payment the refund is performed for

Example: payment_47

signature
string
strictly required

Signature created after you've specified all the request parameters. For more information about signature generation, see Signature generation and verification.

payment
object
strictly required

currency
string
optional

Code of the payment currency in the ISO-4217 alpha-3 format.

This parameter is required when performing a partial refund.

Example: INR

amount
integer
optional

Payment amount in minor currency units without any decimal point or comma except for the cases when the currency doesn't have any minor currency units.

If the currency doesn't have any minor units (i.e. the number of digits for minor currency units is zero), set this parameter to the amount in the major currency units. To check whether the currency has any minor units, see Currency codes.

This parameter is required when performing a partial refund.

Example: 100.00 INR must be sent as 10000

description
string
strictly required

Refund description.

Example: Refund description.

You can also add any other optional parameters to the refund request, if necessary. For the list of all the parameters available in Gate, see API Reference.

Here is an example of the data from a request to initiate a refund with the Banks of India payment method:

Figure 11. Example of the refund request body
{
    "general": {
        "project_id": 1234,
        "payment_id": "payment_47",
        "signature": "kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KU+Y19vySO/RLUkDJrOcZzUCwX6R/ekpZhkIQg=="
    },
    "payment": {
        "currency": "INR",
        "amount": 10000,
        "description": "Refund."
    }
}

Callback

In the Banks of India payment method, the payment platform returns the refund result in a callback. For the information about the callback structure, see Callbacks in Gate.

The following is an example of a callback body with the information about a successfully completed refund.

Figure 12. Example of the body of a successful refund callback
{
    "project_id": 1234,
    "payment": {
        "id": "payment_47",
        "type": "purchase",
        "status": "refunded",
        "date": "2024-12-07T19:08:45+0000",
        "method": "India banks",
        "sum": {
            "amount": 0,
            "currency": "INR"
        },
        "description": ""
    },
    "customer": {
        "id": "customer_123"
    },
    "operation": {
        "id": 47,
        "type": "refund",
        "status": "success",
        "date": "2024-12-07T19:08:45+0000",
        "created_date": "2024-12-07T19:08:05+0000",
        "request_id": "1a23456bc7890de",
        "sum_initial": {
            "amount": 10000,
            "currency": "INR"
        },
        "sum_converted": {
            "amount": 10000,
            "currency": "INR"
        },
        "code": "0",
        "message": "Success",
        "provider": {
            "id": 12345,
            "payment_id": "123abc123-123",
            "auth_code": ""
        }
    },
    "signature": "U7HQO7ToISZhMPKdM4XrUKQtoYzFvoB3cs9CRd4xeYG2Q=="
}

The following is an example of a callback for a declined refund.

Figure 13. Example of the data from a declined refund callback
{
    "project_id": 1234,
    "payment": {
        "id": "payment_47",
        "type": "purchase",
        "status": "success",
        "date": "2024-12-07T19:08:45+0000",
        "method": "India banks",
        "sum": {
            "amount": 10000,
            "currency": "INR"
        },
        "description": ""
    },
    "customer": {
        "id": "customer_123"
    },
    "operation": {
        "id": 47,
        "type": "refund",
        "status": "decline",
        "date": "2024-12-07T19:08:45+0000",
        "created_date": "2024-12-07T19:08:05+0000",
        "request_id": "1a23456bc7890de",
        "sum_initial": {
            "amount": 10000,
            "currency": "INR"
        },
        "sum_converted": {
            "amount": 10000,
            "currency": "INR"
        },
        "code": "20000",
        "message": "General decline",
        "provider": {
            "id": 12345,
            "payment_id": "123abc123-123",
            "auth_code": ""
        }
    },
    "signature": "U7HQO7ToISZhMPKdM4XrUKQtoYzFvoB3cs9CRd4xeYG2Q=="
}

Related topics

Banks available for purchase

Supported banks

In the Banks of India payment method, payments are performed through the banks the payment method supports. For the purchase to be performed, your request must contain the ID of the customer's bank in the account.bank_id parameter.

The table below lists the banks available for purchase in the Banks of India payment method.

Table 4. Banks available for purchase
BankID
ABN Amro6351
Allahabad Bank713
Andhra Bank712
Axis Bank401
Axis Bank Corporate6681
Bank of Bahrain and Kuwait5181
Bank of Baroda416
Bank of Baroda Retail711
Bank of India408
Bank of Maharashtra743
Canara Bank405
Catholic Syrian Bank741
Central Bank of India414
CITI Bank740
City Union Bank739
Corporation Bank738
Cosmos Co-operative Bank5201
DCB Bank736
DCB Bank Corporate6691
Deutsche Bank734
Development Credit Bank4731
Dhanlaxmi Bank6721
Dhanlaxmi Bank733
EQUITAS BANK732
Federal Bank5231
HDFC Bank412
HSBC Bank6361
ICICI Bank406
ICICI Bank Corporate6701
IDBI Bank409
IDFC FIRST Bank5251
Indian Bank402
Indian Overseas Bank735
Indusind Bank730
Industrial Development Bank Of India4761
IngVysya Bank6371
Jammu and Kashmir Bank729
Janta Sahakari bank Ltd714
Karnataka Bank411
KarurVysya Bank6391
Kotak Mahindra Bank404
Lakshmi Vilas Bank NetBanking727
Oriental Bank Of Commerce726
Punjab and Sind Bank724
Punjab National Bank407
Punjab National Bank Corporate6671
Ratnakar Bank4831
Saraswat Bank720
Standard Charter Bank410
State Bank Of Bikaner And Jaipur4851
State Bank of Hyderabad5341
State Bank of India403
State Bank of Mysore6401
State Bank of Patiala5301
State Bank of Travancore5351
Syndicate Bank5321
Tamilnadu Mercantile Bank718
UCO BANK717
Union Bank of India415
Union Bank of India716
Vijaya Bank715
Yes Bank413

The table with the list of banks is provided for informational purposes only. It may change without notice. To get the current list of banks the Banks of India payment method supports, send a request to the payment platform.

Request for the list of available banks

This section provides the instructions on how to build the request for the list of banks supported in the Banks of India payment method.

HTTP request method POST
Request body format JSON
API endpoint /v2/info/banks/india/sale/list
Full API endpoint specification /v2/info/banks/{parentMethod}/{childMethod}/{operationType}/list
Table 5. Parameters required in the request to get the list of banks available in the payment method

strictly required—parameter is required in the initial request.
Object Parameter Description

general
object
strictly required

project_id
integer
strictly required

 Project ID you obtained when integrating with Monetix.

Example: 123

payment_id
string
strictly required

 Payment ID unique within the project.

If the payment is not yet created, set this parameter to a unique value.

Example: payment_47

signature
string
strictly required

 Signature created after you specify all the required parameters. For more information about signature generation, see Signature generation and verification.

payment
object
strictly required

amount
integer
strictly required

 Payment amount in minor currency units without any decimal point or comma except for the cases when the currency doesn't have any minor currency units.

If the currency doesn't have any minor units (i.e. the number of digits for minor currency units is zero), set this parameter to the amount in the major currency units. To check whether the currency has any minor units, see Currency codes.

Example: 100.00 INR must be sent as 10000

currency
string
strictly required

 Code of the purchase currency in the ISO-4217 alpha-3 format.

Example: INR
You can also add any other optional parameters to the request, if necessary. For the list of all the parameters available in Gate, see API Reference.

Here is an example of the data from the request for the list of banks available in the Banks of India payment method.

Figure 14. Example of the data from the request for the list of available banks
{
    "general": {
        "project_id": 200,
        "payment_id": "ORDER_155860015",
        "signature": "K6jll2ym+PtOb3ocZtr345st...=="
    },
    "payment": {
        "amount": 10000,
        "currency": "INR"
    }
}
Figure 15. Example of the response with the list of banks available in the payment method
[
    {
        "minAmount": 100, // Minimum payment amount allowed for the payment (in minor currency units)
        "maxAmount": 1000, // Maximum payment amount allowed for the payment (in minor currency units)
        "limitCurrency": "INR", // Code of the currency used for the payment limits (minAmount and maxAmount) in the ISO-4217 alpha-3 format
        "id": 123, // Bank ID
        "abbr": "EXB", // Bank shortcut name (for internal use)
        "name": "Example Bank", // General bank name
        "nativeName": "Example Bank", // Native bank name
        "currencies": [ // Array with currencies supported by the bank
            {
                "id": 123, // Currency ID in the payment platform
                "alpha_3_4217": "INR", // Alphabetic code of the payment currency in the ISO-4217 alpha-3 format
                "number_3_4217": "123", // Numeric code of the payment currency in the ISO-4217 alpha-3 format
                "currency_type": "fiat", // Type of the currency
                "exponent": 2 // Number of decimal places after decimal point
            }
        ]
    }
]