Banks of India

Overview

Banks of India is a payment method that uses the online banking mechanism for payments through Indian banks. You can perform purchases through this method by using Payment Page and Gate, payouts by using Gate and Dashboard, refunds by using Gate.

General information

Payment method type online banking
Countries and regions IN
Payment currencies INR
Currency conversion on the ECommPay side
Purchases +
Payouts +
Stored credentials payments
Full refunds +
Partial refunds
Chargebacks
Notes
  • Cascade payment processing is supported for working with this method by using Payment Page. For more information, see Cascade payment processing or contact your ECommPay key account manager
  • Two ways of selecting bank for payment are supported: on the Payment Page side and on the provider side. For more information refer to the ECommPay key account manager
  • Payouts are processed during the provider's working hours: from Monday to Friday from 10:30 to 19:00 (GMT+8). During weekends and non-working hours, payouts are not processed. For more information, contact the ECommPay key account manager
Onboarding and access fee refer to your ECommPay key account manager

Interaction diagram

Payment processing by using the Banks of India payment method requires merchant's web service, one of ECommPay interfaces, and the ECommPay payment platform, as well as provider technical facilities.



Operations support

  Interfaces Amounts, INR Times**
Payment Page CMS Plug-ins Gate Dashboard minimum maximum basic threshold
Purchases + + * * within 5 minutes 60 minutes
Payouts + + 1,000.00 500,000.00 * *
Full refunds +

* Contact your ECommPay key account manager for more information.

** The basic and threshold times are defined as follows:

  • The basic time is the average estimated time between the moment a payment is initiated in the payment platform to the moment the payment result is sent to the initiator. The basic time evaluation is made on the assumption of normal operation of all technical facilities and communication channels and typical customer behaviour (if any input from customer is required). Use the basic time to estimate when to react to the absence of payment result notifications or when to check payment status.
  • The threshold time is the maximum possible time between the moment a payment is initiated in the payment platform to the moment the initiator receives the callback with the payment result. A payment is automatically declined, if its waiting time exceeds the threshold time. For individual setting of the threshold time limit, contact ECommPay technical support.

Processing scenarios

In the Banks of India method, purchases and payouts follow different processing procedures. To perform a purchase operation, you need to redirect customer to the provider service, while to perform a payout or a refund, you need to notify customer via merchant's web service.

Figure: Purchase by using Payment Page with bank selection on the Payment Page side



Figure: Purchase by using Payment Page with bank selection on the provider side



Figure: Purchase by using Gate with redirection to the bank site



Figure: Purchase by using Gate with bank selection on the provider side



Figure: Payout by using Gate



Figure: Refund by using Gate



Supported banks

Payments through the Banks of India method are carried out through banks that support the work with this method. Banks have their own identifiers, which are used to initiate payouts and purchases by using Gate, and to display banks on Payment Page when choosing a payment method.

The table below provides information on these banks for informational purposes, it may change without additional notice; for the most recent list of supported banks, contact your ECommPay key account manager or POST the /v2/info/banks/{payment_method}/{operationType}/list request using Gate API: /v2/info/banks/india/sale/list to receive the list of banks supporting purchase processing or /v2/info/banks/india/payout/list—payout processing.

The request must contain the project and payment IDs, signature, currency, and payment amount, as shown in the example. It is important to specify real payment data, but if the payment has not yet been generated, you can specify a random value for the payment ID in the request.

Figure: Example of requesting a list of banks

{
  "general": {
    "project_id": 200,
    "payment_id": "ORDER_155860015",
    "signature": "K6jllym+PtObocZtr345st...=="
  },
  "payment": {
    "amount": 1000,
    "currency": "INR"
  }
}
Table 1. List of banks
Bank ID
Axis Bank 401
Bank of Baroda 416
Bank of India 408
Canara Bank 405
Central Bank of India 414
HDFC Bank 412
ICICI Bank 406
IDBI Bank 409
Indian Bank 402
Karnataka Bank 411
Kotak Mahindra Bank 404
Punjab National Bank 407
Standard Charter Bank 410
State Bank of India 403
Union Bank of India 415
Yes Bank 413

The sections that follow provide detailed information about what you need to perform payments and how you can analyse the information on payments and operations.

Purchase by using Payment Page

General information

In the Banks of India method, when processing a purchase by using Payment Page, the merchant web service should send a request with all the required parameters and signature to the ECommPay URL and get the callback with the payment result from the payment platform. When opening Payment Page, you can have Payment Page opened the Banks of India method selected. For more information about preselecting payment methods, see in Preselecting payment method. The full sequence and particularities of the purchase process are provided below.

Figure: Purchase sequence by using Payment Page with bank selection on the Payment Page side



Figure: Purchase sequence by using Payment Page with bank selection on the Payment Page side

  1. A customer initiates a purchase on the merchant's web service.
  2. The web service sends the request for Payment Page opening to the specified ECommPay URL.
  3. The request for opening is redirected to the payment platform.
  4. The payment platform performs the initial request processing that involves validation of the required parameters and signature.
  5. Requested Payment Page is generated into the ECommPay payment platform as specified in the project settings and the request parameters.
  6. Payment Page is displayed to the customer.
  7. The customer selects one of the banks from Banks of India group and agrees to use the method (or accepts the method already selected on Payment Page and agrees).
  8. The payment platform receives the purchase request for payment processing.
  9. The payment platform performs the internal purchase request processing and sends it to the bank service.
  10. The purchase request is processed on the bank service side.
  11. The bank service generates the data for redirecting the customer to its website form and sends it to the payment platform.
  12. The payment platform sends the customer redirection data to Payment Page.
  13. The customer is redirected to the bank website.
  14. The customer completes all the required payment steps.
  15. The payment is processed on the bank side.
  16. The result is displayed to the customer on the bank website.
  17. The customer is redirected to Payment Page.
  18. The bank service sends the result notification to the payment platform.
  19. The payment platform sends a callback with the payment result to the web service.
  20. The payment platform sends the result to Payment Page.
  21. A page with the payment result information is displayed to the customer on Payment Page.

Figure: Purchase sequence by using Payment Page with bank selection on the provider side



Figure: Purchase sequence by using Payment Page with bank selection on the provider side

  1. A customer initiates a purchase on the merchant's web service.
  2. The web service sends the request for Payment Page opening to the specified ECommPay URL.
  3. The request for opening is redirected to the payment platform.
  4. The payment platform performs the initial request processing that involves validation of the required parameters and signature.
  5. Requested Payment Page is generated into the ECommPay payment platform as specified in the project settings and the request parameters.
  6. Payment Page is displayed to the customer.
  7. The customer selects the Banks of India method and agrees to use the method (or accepts the method already selected on Payment Page and agrees).
  8. The payment platform receives the purchase request for payment processing.
  9. The payment platform performs the internal purchase request processing and sends it to the provider service.
  10. The purchase request is processed on the provider service side.
  11. The provider service generates the data for redirecting the customer to the bank selection page and sends it to the payment platform.
  12. The payment platform sends the customer redirection data to Payment Page.
  13. The customer is redirected to the bank selection page.
  14. The customer selects bank for payment.
  15. The customer is redirected to the bank site.
  16. The bank payment form is displayed to the customer.
  17. The customer completes all the payment steps required.
  18. The payment is processed on the bank side.
  19. The result is displayed to the customer on the bank website.
  20. The bank service sends the result notification to the provider service.
  21. The provider service sends the result notification to the payment platform.
  22. The payment platform sends a callback with the payment result to the web service.
  23. The payment platform sends the result to Payment Page.
  24. A page with the payment result information is displayed to the customer on Payment Page.

The sections that follow discuss in more details the request format and the Payment Page parameters to use in the Banks of India payment method and provide the information on the format of callbacks with payment results. For the general information on how to use the API, see Payment Page API Description.

Request format

There are several things you need to consider when using the Banks of India method:

  1. You must provide values for the basic minimum of parameters. Listed below are the parameters that are mandatory for any payment method:
    • project_id—the project ID obtained from ECommPay
    • payment_id—payment ID unique within the project
    • payment_currency—payment currency in ISO-4217 alpha-3 format
    • payment_amount—payment amount in minor units
    • customer_id—the unique ID of the customer within your project
  2. Depending on the provider processing the payment, it can be necessary to specify the customer information in the following parameters:
    • customer_first_name—first name
    • customer_last_name—last name
    • customer_phone—phone number
    • customer_email—email address
    • customer_zip—postal code
    • customer_city—city
    • customer_address—address in the specified city
    If the request is missing the parameters, on Payment Page the additional fields are displaying to the customer to input missing data. For more details about clarification, see Submission of additional payment information.
  3. You can customise the selecting payment method page on Payment Page.

    By default, banks that support Banks of India payment method are grouped in one button on Payment Page, so the selection of a bank is carried out in two steps.

    Purchase by using Payment Page with bank selection on the provider side

    When performing purchases by using Payment Page with bank selection on the provider side, first, customer chooses the Banks of India method on the Payment Page, and then customer is redirected to the bank selection page for final bank selection. In that case it is possible to display Payment Page with preselected payment method. For that, pass the online-indian-banks code in the force_payment_method parameter.

    Purchase by using Payment Page with bank selection on the Payment Page side

    When performing purchases by using Payment Page with bank selection on the Payment Page side, first, the Banks of India method is chosen among others, and then a particular bank is selected on the next page with the list of the group banks. There are several options for displaying the page with the selecting of payment method on Payment Page:

    • To display each bank of the Banks of India group with a separate buttons, pass split_banks=true in the request for opening in the payment_methods_options string.
      payment_methods_options={"online_indian_banks": {"split_banks": true}}
      
    • To display a button of a specific bank (one or several) from Banks of India group on Payment Page in the list of payment methods, pass the bank identifier in the banks_id parameter. If it is necessary to display several banks from a group, pass the identifiers of these banks separated by a comma with a space.
      payment_methods_options={"online_indian_banks": {"split_banks": true, "banks_id": [416, 415]}}
    • To preselect Banks of India as the payment method on Payment Page for customers, pass the code online-indian-banks in the force_payment_method parameter in the request for opening. The list of the banks from Banks of India group is displayed to a customer on Payment Page bypassing the page with the payment method selection.
    • To immediately redirect a customer to the website of the specific bank from the Banks of India group, pass the code online-indian-banks in the force_payment_method parameter and the bank identifier banks_id in the payment_methods_options string. The customer is redirected to the bank website without confirming willingness to pay, bypassing the pages with the payment method selection and the choice of banks on Payment Page.

      Figure: Example of the request for redirecting customer to the bank website

          { 
            payment_id: 'X03936', 
            payment_amount: 200000, 
            payment_currency: 'INR', 
            project_id: 115,
            customer_id: 'customer123',
            customer_first_name: 'John',
            customer_last_name: 'Smith',
            customer_email: 'smith@example.com',
            customer_zip: '400009',
            customer_city: 'Mumbai',
            customer_address: '99, Chakla Street, Masjid Bunder (east)'
            force_payment_method: 'online-indian-banks',
            payment_methods_options={"online_indian_banks": {"banks_id": [416]}},
            signature: "kUi2x9dKHAVNU0FYlSCQ9vySUkDJrOcZzUCwX6R\/ekpZhkIQg=="
          }
  4. If required, you can also add any other additional parameters Payment Page supports.
  5. After you specify all the parameters you need, you must create the signature for the request. For instructions on how to sign a payment request, see Signature generation and verification.

Thus, a correct payment request in the Banks of India method must include project, customer and payment IDs, the currency and the amount of a payment, customer information, as shown in the following example:

    { 
      payment_id: 'ID_183', 
      payment_amount: 10000, 
      payment_currency: 'INR', 
      project_id: 238,
      customer_id: 'customer123',
      customer_first_name: 'John',
      customer_last_name: 'Smith',
      customer_email: 'smith@example.com',
      customer_zip: '400009',
      customer_city: 'Mumbai',
      customer_address: '99, Chakla Street, Masjid Bunder (east)'
      signature: "hlhydUV+SmGJYhm6G.....5JuyamXS/BYQ1M2IUgBuVxa93HwzBbEjF9Veg=="
    }

For information about all parameters available in the Banks of India method , see Payment Page invocation parameters.

Callback format

The Banks of India method uses the standard format for callbacks to deliver purchase results. For more information, see Callbacks.

The following is the example of a callback with an information about successful 10.00 INR purchase made in the 239 project.

Figure: Example of a successful purchase callback

{
        "project_id": 239,
        "payment": {
            "id": "EP8550-ad59",
            "type": "purchase",
            "status": "success",
            "date": "2020-05-13T09:06:45+0000",
            "method": "India banks",
            "sum": {
                "amount": 1000,
                "currency": "INR"
            },
            "description": "test"
        },
        "customer": {
            "id": "345435435"
        },
        "operation": {
            "id": 548,
            "type": "sale",
            "status": "success",
            "date": "2020-05-13T09:06:45+0000",
            "created_date": "2020-05-13T09:05:47+0000",
            "request_id": "7b0f630c3f2f395bba2738cf90866bd4dd50bd3-00000001",
            "sum_initial": {
                "amount": 1000,
                "currency": "INR"
            },
            "sum_converted": {
                "amount": 1000,
                "currency": "INR"
            },
            "code": "0",
            "message": "Success",
            "provider": {
                "id": 2080,
                "payment_id": "15141-1589360772-25",
                "auth_code": ""
            }
        },
        "signature": "rSV33iKYiOVpXctCvTGTg3...GLZny35xplogtGYT1w=="
    }

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

Figure: Example of a declined purchase callback

{
        "project_id": 239,
        "payment": {
            "id": "EP8550-ad59",
            "type": "purchase",
            "status": "decline",
            "date": "2020-05-13T09:06:45+0000",
            "method": "India banks",
            "sum": {
                "amount": 1000,
                "currency": "INR"
            },
            "description": "test"
        },
        "customer": {
            "id": "123"
        },
        "operation": {
            "id": 548,
            "type": "sale",
            "status": "decline",
            "date": "2020-05-13T09:06:45+0000",
            "created_date": "2020-05-13T09:05:47+0000",
            "request_id": "7b0f630c3f2f395bba2738cf9086622bd4dd50bd3-00000002",
            "sum_initial": {
                "amount": 1000,
                "currency": "INR"
            },
            "sum_converted": {
                "amount": 1000,
                "currency": "INR"
            },
            "code": "20000",
            "message": "decline",
            "provider": {
                "id": 2080,
                "payment_id": "",
                "auth_code": ""
            }
        },
        "signature": "rSV33iKYiOVpXctCvTGTg3...GLZny35xplogtGYT1g=="
    }

Related topics

The following topics might be useful when implementing payments by using Payment Page:

Purchase by using Gate

General information

In the Banks of India method, when processing a purchase by using Gate, the merchant web service is required to do the following:

  1. Send a request with all the required parameters and signature to the ECommPay URL.
  2. Perform the redirection of a customer to the website of the bank that supports payment processing by using the Banks of India method, or the bank selection page.
  3. Get the callback with the payment result from the payment platform.

The following diagram provides the detailed picture of the payment processing procedure.

Figure: Purchase sequence by using Gate with redirection to the bank site



Figure: Purchase sequence by using Gate with redirection to the bank site

  1. A customer initiates a purchase through one of the Banks of India group banks on the merchant's web service side.
  2. The web service sends the request for processing the purchase by using Gate to the specified ECommPay URL.
  3. The payment platform receives the request for processing the purchase from Gate.
  4. The payment platform performs the initial request processing that includes validation of the required parameters and signature.
  5. The payment platform sends the response with request receipt confirmation and correctness check result to the web service. For more information, see Response format.
  6. The payment platform performs the internal payment request processing and redirects the request to the bank service.
  7. The request is processed on the bank side.
  8. The bank service sends the data for redirecting the customer to the selected bank website to the payment platform.
  9. The payment platform sends the callback with the redirection data to the web service.
  10. The customer is redirected from the web service to the selected bank website.
  11. The customer completes all the payment steps required on the bank website.
  12. The payment is processed on the bank side.
  13. The result is displayed to the customer on the bank website.
  14. The customer is redirected to the merchant's web service.
  15. The bank service sends the payment result notification to the payment platform.
  16. The ECommPay payment platform sends a callback to the web service.
  17. The customer receives the payment result on the web service.

Figure: Purchase sequence by using Gate with redirection to the bank selection page



Figure: Purchase sequence by using Gate with redirection to the bank selection page

  1. A customer initiates a purchase through one of the Banks of India group banks on the merchant's web service side.
  2. The web service sends the request for processing the purchase by using Gate to the specified ECommPay URL.
  3. The payment platform receives the request for processing the purchase from Gate.
  4. The payment platform performs the initial request processing that includes validation of the required parameters and signature.
  5. The payment platform sends the response with request receipt confirmation and correctness check result to the web service. For more information, see Response format.
  6. The payment platform performs the internal payment request processing and redirects the request to the provider service.
  7. The request is processed on the provider side.
  8. The provider service sends the data for customer redirection to the bank selection page to the payment platform.
  9. The payment platform sends the callback with the redirection data to the web service.
  10. The customer is redirected from website to the bank selection page.
  11. The customer selects bank for payment.
  12. The customer is redirected to the bank site.
  13. The bank payment form is displayed to the customer.
  14. The customer completes all the payment steps required.
  15. The payment is processed on the bank side.
  16. The result is displayed to the customer on the bank website.
  17. The customer is redirected to the merchant's web service.
  18. The bank service sends the payment result notification to the provider service.
  19. The provider service sends the payment result notification to the payment platform.
  20. The ECommPay payment platform sends a callback to the web service.
  21. The customer receives the payment result on the web service.

The sections that follow discuss in more details the request format and the Gate parameters to use in the Banks of India payment method and provide the information on the format of callbacks with purchase results.

Request format

There are several things you must consider when using purchase requests in the Banks of India method:
  1. You perform purchase by sending the /v2/payment/banks/india/sale request by using POST (HTTP) method. This is an online banking request group: /v2/payment/banks/{payment_method}/sale
  2. The following objects and parameters must be specified in any request:
    • Object general—general request identification information:
      • project_id—the project ID obtained from ECommPay
      • payment_id—payment ID unique within the project
      • signature—signature created after you specify all the required parameters. For more information about signature generation, see Signature generation and verification.
    • Object payment—payment information:
      • amount—purchase amount in minor units
      • currency—purchase currency in ISO-4217 alpha-3 format
    • Object customer—customer information:
      • id—the unique ID of the customer within your project
      • ip_address—customer IP address
    • Object return_url—contains the URLs to which customer is redirected while or after payment processing:
      • success—URL to return customer to the web service after a successful payment.
  3. Depending on the provider processing the payment, it can be necessary to specify customer information in additional parameters. If the request is missing the parameters, the list of parameters is sent in the clarification callback. For more details, see Additional payment information submission.

    There is the list of recommended objects and parameters:

    • Object customer—customer information:
      • first_name—first name
      • last_name—last name
      • phone—phone number
      • email—email
      • zip—postal code
      • city—city
      • address—address in the specified city
  4. If required, you can also add any other additional parameters Gate supports.

Thus, a correct payment request in the Banks of India method must include project, customer and payment IDs, currency and amount of the purchase, customer information and URL for redirection, as shown in the following example:

Figure: Example of a purchase request

{
  "general": {
    "project_id": 123,
    "payment_id": "ORDER_1558600157",
    "signature": "+K6jllym+PtObocZ...A4NcWxfWJTXdESkijfsBeR6bKROUsslA=="
  },
  "customer": {
    "email": "waynen@example.com",
    "first_name": "John",
    "last_name": "Waynen",
    "phone": "123456789",
    "zip": "400009",
    "city": "Mumbai",
    "address": "99, Chakla Street, Masjid Bunder (east)",
    "ip_address": "1.2.3.4",
    "id": "customer1"
  },
  "payment": {
    "amount": 1500,
    "currency": "INR",
  },
  "return_url": {
    "success": "https://www.example.com"
  }
}

Formats of the customer redirection data

To redirect a customer from the web service to the bank site, you must receive a callback from the payment platform containing the URL for redirection in the redirect_data.url parameter and data to be sent in the request body in the redirect_data.body parameter, and use these parameters when opening the bank's HTML page using the method specified in the redirect_data.method parameter.

The following is the callback fragment containing the redirection data.

  "redirect_data": {
    "body": {...},
    "method": "GET",
    "url": "https://example.com/payment/initialize/api/123"
  }

Callback format

The Banks of India method uses the standard format for callbacks to deliver purchase results. For more information, see Callbacks.

The following is the example of a callback with an information about successful 10.00 INR purchase made in the 239 project.

Figure: Example of a successful purchase callback

{
        "project_id": 239,
        "payment": {
            "id": "EP8550-ad59",
            "type": "purchase",
            "status": "success",
            "date": "2020-05-13T09:06:45+0000",
            "method": "India banks",
            "sum": {
                "amount": 1000,
                "currency": "INR"
            },
            "description": "test"
        },
        "customer": {
            "id": "345435435"
        },
        "operation": {
            "id": 548,
            "type": "sale",
            "status": "success",
            "date": "2020-05-13T09:06:45+0000",
            "created_date": "2020-05-13T09:05:47+0000",
            "request_id": "7b0f630c3f2f395bba2738cf9086622bd4dd50bd3-00000001",
            "sum_initial": {
                "amount": 1000,
                "currency": "INR"
            },
            "sum_converted": {
                "amount": 1000,
                "currency": "INR"
            },
            "code": "0",
            "message": "Success",
            "provider": {
                "id": 2080,
                "payment_id": "15141-1589360772-25",
                "auth_code": ""
            }
        },
        "signature": "rSV33iKYiOVpXctCvTGTg3...GLZny35xplogtGYT1w=="
    }

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

Figure: Example of a declined purchase callback

{
        "project_id": 239,
        "payment": {
            "id": "EP8550-ad59",
            "type": "purchase",
            "status": "decline",
            "date": "2020-05-13T09:06:45+0000",
            "method": "India banks",
            "sum": {
                "amount": 1000,
                "currency": "INR"
            },
            "description": "test"
        },
        "customer": {
            "id": "123"
        },
        "operation": {
            "id": 548,
            "type": "sale",
            "status": "decline",
            "date": "2020-05-13T09:06:45+0000",
            "created_date": "2020-05-13T09:05:47+0000",
            "request_id": "7b0f630c3f2f395bba2738cf9086622bd4dd50bd3-00000002",
            "sum_initial": {
                "amount": 1000,
                "currency": "INR"
            },
            "sum_converted": {
                "amount": 1000,
                "currency": "INR"
            },
            "code": "20000",
            "message": "decline",
            "provider": {
                "id": 2080,
                "payment_id": "",
                "auth_code": ""
            }
        },
        "signature": "rSV33iKYiOVpXctCvTGTg3...GLZny35xplogtGYT1g=="
    }

Related topics

The following topics might be useful when implementing payments through Gate:

Refunds by using Gate

General information

Banks of India supports full refunds processing. In the Banks of India method, any refund follows the usual procedure which is common to Gate: merchant's web service sends a request with all the required parameters and signature to ECommPay URL, Gate accepts the request and redirects to the payment platform for further processing. The full sequence of the refund process is provided below.

Figure: Refund sequence when using Gate

  1. A customer orders a refund on the merchant's web service side.
  2. Merchant's web service sends the request for the refund processing by using Gate to the appropriate ECommPay URL.
  3. Gate redirects the request to the ECommPay payment platform.
  4. The payment platform performs all the necessary checks and processes the request.
  5. The reply with the request processing results is sent to the merchant's web service. For more information, see Response format.
  6. The payment platform redirects the refund request to the provider service.
  7. The payment is processed on the provider side.
  8. Provier sends the result notification to the payment platform.
  9. The payment platform sends a callback with the payment result to the web service.
  10. The customer receives the refund result from the web service.

The sections that follow discuss in more details the request format and the Gate parameters to use in the Banks of India payment method and provide the information on the format of callbacks with refund results.

Request format

There are several things you must consider when using refund requests in the Banks of India method:
  1. You perform a refund by sending the request to /v2/payment/banks/india/refund by using the POST HTTP method. This is an online banking request group /v2/payment/banks/{payment_method}/refund.
  2. The following objects and parameters must be specified in any request:
    • Object general—general request identification information:
      • project_id—the project ID obtained from ECommPay
      • payment_id—payment ID unique within the project
      • signature—signature created after you specify all the required parameters. For more information about signature generation, see Signature generation and verification.
    • Object payment—refund information:
      • description—comment or description
  3. If required, you can also add any other additional parameters Gate supports.

Thus, a correct refund request in the Banks of India method must include project and payment IDs, description of the refund, as shown in the following example:

Figure: Example of a refund request

{
  "general": {
    "project_id": 101,
    "payment_id": "ECT_TEST_1572258898441234343232",
    "signature": "NUpXRpdrU/rRcwEa/jQYoYbXA/YIc/dgeuncPmD/BJZGZvt59GbTSAUKHI/WrQ=="
  },
  "payment": {
    "description":"test_refund"
  }

Callback format

The Banks of India method uses the standard format for callbacks to deliver refund results. For more information, see Callbacks.

The following is the example of a callback with an information about successful 350.00 INR refund in the 197 project.

Figure: Example of a successful refund callback

{
        "project_id": 197,
        "payment": {
            "id": "TEST_554862",
            "type": "purchase",
            "status": "refunded",
            "date": "2020-09-09T10:02:18+0000",
            "method": "India banks",
            "sum": {
                "amount": 0,
                "currency": "INR"
            },
            "merchant_refund_id": "TEST_554862",
            "description": "TEST_554862"
        },
        "customer": {
            "id": "1",
            "phone": "1234567890"
        },
        "operation": {
            "id": 90266010010271,
            "type": "refund",
            "status": "success",
            "date": "2020-09-09T10:02:18+0000",
            "created_date": "2020-09-09T09:46:14+0000",
            "request_id": "6b77b588d77d5c27be31be7b72bf9adf...b1c85eda238b73cac-00090267",
            "sum_initial": {
                "amount": 35000,
                "currency": "INR"
            },
            "sum_converted": {
                "amount": 35000,
                "currency": "INR"
            },
            "code": "0",
            "message": "Success",
            "provider": {
                "id": 1751,
                "payment_id": "4952688",
                "auth_code": ""
            }
        },
        "signature": "WUZUy26FHZglsro9PYFr89suJAciQ...5Fev4NtHl56VGTgX9m/g=="
    }

The following is the example of a callback for a refund declined as the amount in the refund requested is greater than the amount in the initial payment.

Figure: Example of a declined refund callback

{
        "project_id": 197,
        "payment": {
            "id": "TEST_554863",
            "type": "purchase",
            "status": "success",
            "date": "2020-09-09T10:02:18+0000",
            "method": "India banks",
            "sum": {
                "amount": 35000,
                "currency": "INR"
            },
            "merchant_refund_id": "TEST_554863",
            "description": "TEST_554863"
        },
        "customer": {
            "id": "1",
            "phone": "1234567890"
        },
        "operation": {
            "id": 90266010010272,
            "type": "refund",
            "status": "decline",
            "date": "2020-09-09T10:02:18+0000",
            "created_date": "2020-09-09T09:46:14+0000",
            "request_id": "6b77b588d77d5c27be31be7b72bf9adf...b1c85eda238b73cac-00090268",
            "sum_initial": {
                "amount": 35000,
                "currency": "INR"
            },
            "sum_converted": {
                "amount": 35000,
                "currency": "INR"
            },
            "code": "3283",
            "message": "Refund amount more than init amount"
            }
        },
        "signature": "WUZUy26FHZglsro9PYFr89suJAciQ...5Fev4NtHl56VGTgX9m/g=="
    }

Related topics

The following topics might be useful when implementing payments through Gate:

Payout by using Gate

General information

To perform a payout through the Banks of India method, merchant's web service sends a request with all the required parameters and signature to ECommPay URL, and receives a callback with the payment result. The full sequence of the payout process is provided below.



Figure: Payout by using Gate

  1. A customer orders a payout through the Banks of India system.
  2. Merchant's web service sends the request for the payout processing by using Gate to the appropriate ECommPay URL.
  3. Gate redirects the request to the ECommPay payment platform.
  4. The payment platform performs all the necessary checks and processes the request.
  5. The reply with the request processing results is sent to the merchant's web service. For more information, see Response format.
  6. The payment platform redirects the payout request to the provider service.
  7. The payout is processed on the provider side.
  8. Provider sends the result notification to the payment platform.
  9. The payment platform sends a callback with the payment result to the web service.
  10. The customer receives the notification about the payout result from the web service.

The sections that follow discuss in more details the request format and the Gate parameters to use in the Banks of India payment method and provide the information on the format of callbacks with payout results.

Request format

There are several things you must consider when using payout requests in the Banks of India method:
  1. You perform payouts by sending the /v2/payment/banks/india/payout request by using POST (HTTP) method. This is an online banking request group: /v2/payment/banks/{payment_method}/payout
  2. The following objects and parameters must be specified in any request:
    • Object general—general request identification information:
      • project_id—the project ID obtained from ECommPay
      • payment_id—payment ID unique within the project
      • signature—signature created after you specify all the required parameters. For more information about signature generation, see Signature generation and verification.
    • Object payment—payout information:
      • amount—payout amount
      • currency—payout currency in the ISO-4217 alpha-3 format.
    • Object customer—customer information:
      • id—customer identifier on the web service side
      • ip_address—IP address
    • Object account—recipient account information:
      • number—recipient account number
      • bank_code—IFSC code of the bank branch
      • bank_id—bank identifier
      • customer_name—full name of the bank account holder
  3. If required, you can also add any other additional parameters Gate supports.

Thus, a correct payment request in the Banks of India method must include project and payment IDs, signature, account and customer information, currency and amount of the payout, as shown in the following example:

Figure: Example of a payout request

{
  "general": {
    "project_id": 818,
    "payment_id": "ORDER_I1558600157",
    "signature": "+K6jllym+PtObocZ1yS...xfWJTXdESkijfsBeR6bKROUsslA=="
  },
  "payment": {
    "amount": 150000,
    "currency": "INR"
  },
  "customer": {
    "id": "24900",
    "ip_address": "1.2.3.4"
  },
  "account": {
    "customer_name": "John Waynen",
    "bank_code": "test_code",
    "bank_id": 401,
    "number": "5588994446666"
  }
}

Callback format

The Banks of India method uses the standard format for callbacks to deliver payout results. For more information, see Callbacks.

The following is the example of a callback with an information about successful 1000.00 INR payout made in the 239 project.

Figure: Example of a successful payout callback

{
        "project_id": 239,
        "payment": {
            "id": "ORDER53",
            "type": "payout",
            "status": "success",
            "date": "2020-05-21T13:23:32+0000",
            "method": "India banks",
            "sum": {
                "amount": 100000,
                "currency": "INR"
            },
            "description": "description"
        },
        "account": {
            "number": "123456"
        },
        "customer": {
            "id": "24901"
        },
        "operation": {
            "id": 1386,
            "type": "payout",
            "status": "success",
            "date": "2020-05-21T13:23:32+0000",
            "created_date": "2020-05-21T13:23:28+0000",
            "request_id": "e48da2df266940ce5f534ae31237ca774b6fb-00000002",
            "sum_initial": {
                "amount": 100000,
                "currency": "INR"
            },
            "sum_converted": {
                "amount": 100000,
                "currency": "INR"
            },
            "code": "0",
            "message": "Success",
            "provider": {
                "id": 2080,
                "payment_id": "15141-1589360772-26",
                "auth_code": ""
            }
        },
        "signature": "UvYafKv8g7aXBIqVVEWAl7KCF8y...Wt8F+7erV2ugNHq6Wv3lJE8Q=="
    }

The following is the example of a callback for a declined payout.

Figure: Example of a declined payout callback

{
        "project_id": 239,
        "payment": {
            "id": "ORDER54",
            "type": "payout",
            "status": "decline",
            "date": "2020-05-21T13:23:32+0000",
            "method": "India banks",
            "sum": {
                "amount": 1000,
                "currency": "INR"
            },
            "description": "description"
        },
        "account": {
            "number": "123456"
        },
        "customer": {
            "id": "24900"
        },
        "operation": {
            "id": 1386,
            "type": "payout",
            "status": "decline",
            "date": "2020-05-21T13:23:32+0000",
            "created_date": "2020-05-21T13:23:28+0000",
            "request_id": "e48da2df266940ce5f534c84cc031237ca774b6fb-00000001",
            "sum_initial": {
                "amount": 1000,
                "currency": "INR"
            },
            "sum_converted": {
                "amount": 1000,
                "currency": "INR"
            },
            "code": "20000",
            "message": "General decline",
            "provider": {
                "id": 2080,
                "payment_id": "",
                "auth_code": ""
            }
        },
        "signature": "UvYafKv8g7aXBIqVVEWAl7KCF8y...Wt8F+7erV2ugNHq6Wv3lJE8Q=="
    }

Related topics

The following topics might be useful when implementing payments through Gate:

Payouts by using Dashboard

To make a payout through Dashboard, the merchant sends a request, and receives a notification with the request processing result. There are two ways to initiate payouts through Dashboard:
  • as a single payout—in this case, you must specify the currency and amount for a payout available for this method, and fill in all fields required on the Dashboard interface in accordance with the selected payment method
  • as a part of a mass payment—in this case, all parameters are specified in a CSV file in accordance with the requirements in the Payouts by using Gate section (except for the signature)

Information about performed payouts is displayed in the Payments section of Dashboard.

More detailed information on the payout processing by using Dashboard is provided in the Bulk payments section.

Analysis of payments results

As with other payment methods ECommPay offers, when using the Banks of India method, you have several options to analyse the information about payments and operations performed by using the method—alone or in conjunction with other methods.

You can load and analyse all the necessary information in Dashboard, for instance you can use the analytic panels on the Analytics tab to this end.

Also, you can export the information for further analysis by using third party analytical tools. The following options are available:

  • Dashboard allows you to download reports in CSV and XLS formats—by using the tools on the Payments tab. You can perform export as a one-time download to your local computer or have payment data regularly exported and delivered to email addresses you specify.
  • Data API allows you to have payment information exported in JSON format and delivered to a URL you specify. The payment information is exported by using the /operations/get queries.

If you have any further questions regarding payment data analysis, contact ECommPay technical support.