Banks of India

Interaction diagram

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

Operations support

	Interfaces			Amounts, INR		Times
	Payment Page	Gate	Dashboard	minimum	maximum	basic	threshold
Purchases				*	*	*	*
Payouts				*	*	*	*
Full refunds						*	*
Partial refunds						*	*

* Contact your Monetix key account manager for more information.

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 click the Payment methods tab.

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.

Supported banks

Payments through the Banks of India method are carried out through banks that support the method. To initiate payouts and purchases by using Gate, you use bank identifiers, which are also used to display banks on Payment Page where your customer can choose payment method.

The table below provides information about supported banks. Note that this list is intended for informational purposes only.

Table 1. List of banks

Bank	ID	Purchase	Payout
ABN Amro	6351
Allahabad Bank	713
Andhra Bank	712
Axis Bank	401
Axis Bank Corporate	6681
Bank of Bahrain and Kuwait	5181
Bank of Baroda	416
Bank of Baroda Retail	711
Bank of India	408
Bank of Maharashtra	743
Canara Bank	405
Catholic Syrian Bank	741
Central Bank of India	414
CITI Bank	740
City Union Bank	739
Corporation Bank	738
Cosmos Co-operative Bank	5201
DCB Bank	736
DCB Bank Corporate	6691
Deutsche Bank	734
Development Credit Bank	4731
Dhanlaxmi Bank	6721
Dhanlaxmi Bank	733
EQUITAS BANK	732
Federal Bank	5231
HDFC Bank	412
HSBC Bank	6361
ICICI Bank	406
ICICI Bank Corporate	6701
IDBI Bank	409
IDFC FIRST Bank	5251
Indian Bank	402
Indian Overseas Bank	735
Indusind Bank	730
Industrial Development Bank Of India	4761
IngVysya Bank	6371
Jammu and Kashmir Bank	729
Janta Sahakari bank Ltd	714
Karnataka Bank	411
KarurVysya Bank	6391
Kotak Mahindra Bank	404
Lakshmi Vilas Bank NetBanking	727
Oriental Bank Of Commerce	726
Punjab & Sind Bank	724
Punjab National Bank	407
Punjab National Bank Corporate	6671
Ratnakar Bank	4831
Saraswat Bank	720
Standard Charter Bank	410
State Bank Of Bikaner And Jaipur	4851
State Bank of Hyderabad	5341
State Bank of India	403
State Bank of Mysore	6401
State Bank of Patiala	5301
State Bank of Travancore	5351
Syndicate Bank	5321
Tamilnadu Mercantile Bank	718
UCO BANK	717
Union Bank of India	415
United Bank of India	716
Vijaya Bank	715
Yes Bank	413

Since the list may change without additional notice, to get the most recent list of supported banks, you need to use the Gate API to send a POST request to one of the /v2/info/banks/{payment_method}/{operationType}/list endpoints.

Use following endpoints for the Banks of India method:

• /v2/info/banks/india/sale/list— to get the list of banks that support purchase processing.
• /v2/info/banks/india/payout/list— to receive the list of banks that support payout processing.

The following objects and parameters must be specified in request for the list of supported banks:

• general—object with general request information:
  • project_id—the project ID obtained from Monetix
  • 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.
• payment—object with payment information:
  • amount—payment amount in minor currency units without any decimal point or comma except for cases where the currency does not have any minor currency units. If the currency have no minor units (that is, the number of digits for minor currency units is zero), then you must set this parameter to the amount in the major currency units. For the information on whether the currency has any minor units, see Currency codes.
  • currency—purchase currency in ISO-4217 alpha-3 format

Here is an example of the data from a request for the supported banks list. 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.

{
  "general": {
    "project_id": 200,
    "payment_id": "ORDER_155860015",
    "signature": "K6jllym+PtObocZtr345st...=="
  },
  "payment": {
    "amount": 1000,
    "currency": "INR"
  }
}

[
    {
        "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
            }
        ]
    }
]

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

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 Monetix 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 Preselecting payment methods.

The full sequence of the purchase workflow is provided below.

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 required for any payment method:
   • project_id—project ID obtained from Monetix
   • payment_id—payment ID unique within the project
   • customer_id—unique ID of the customer within your project
   • customer_first_name—customer first name
   • customer_last_name—customer last name
   • customer_email—customer email
   • payment_currency—code of payment currency in ISO-4217 alpha-3 format
   • payment_amount—payment amount in minor currency units without any decimal point or comma except for cases where the currency does not have any minor currency units. If the currency has no minor units (that is, the number of digits for minor currency units is zero), then you must set this parameter to the amount in the major currency units. For the information on whether the currency has any minor units, see Currency codes.
2. Depending on the provider processing the payment, it can be necessary to specify the phone number of the customer in the customer_phone parameter. The phone number must consist of 10 digits or 12 digits—if the number includes the country code of India (91). If the parameter is missing from the request, Payment Page will contain an additional field for the customer to enter missing information. For more information about the additional information submission, see Submission of additional payment information.
3. There are several options to customize the payment method selection page on Payment Page.
   • Bank selection in two steps This option is used by default. The banks that support Banks of India payment method are grouped in one button on Payment Page, therefore bank selection is carried out in two steps. On the first step, the Banks of India method is chosen among others, and then, on the second step, particular bank is selected on the next page with the list of the group banks.
   • Display each bank as a separate button along with other payment methods To show each bank of the Banks of India group as a separate button, set the split_banks parameter in the payment_methods_options object to true.

     payment_methods_options={"online_indian_banks": {"split_banks": true}}

   • Show the banks of only one payment method To show only the banks available in the Banks of India payment method on Payment Page for customers, pass the code online-indian-banks in the force_payment_method parameter. The customer will see only the banks available in the Banks of India method.
   • Show only selected banks To display a button of specific banks (one or several) from Banks of India group on Payment Page in the list of payment methods, set force_payment_method to online-indian-banks and add an array with IDs of the banks to show on Payment Page in the banks_id parameter. For example:

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

     Here is an example of a request to open Payment Page with specific pre-selected bank:

     EPayWidget.run(
         {
             project_id: 1234,
             payment_id: "X03936",
             customer_id: "customer_123",
             customer_first_name: 'John',
             customer_last_name: 'Doe',
             customer_email: 'johndoe@email.com',
             payment_currency: "INR",
             payment_amount: 25000,
             force_payment_method: "online-indian-banks",
             payment_methods_options: {"online_indian_banks": {"banks_id": [416]}},
             signature: "kUi2x9dKHAVNU0FY...vySO\/RLCvhtT4DqtVUkDJrOcZzUCwX6R\/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.

Here is an example of data from a purchase request:

EPayWidget.run(    
    { 
        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_phone: '911234567890',
        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 in Payment Page.

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

{
        "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.

{
        "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:

• Integration procedure
• Payment types, operations and payments
• Signature generation and verification
• Operation statuses and response codes

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 Monetix URL.
2. Redirect the customer to the bank service.
3. Accept the callback with the payment result from the payment platform.

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

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

1. You initiate a purchase by submitting a purchase request to the /v2/payment/banks/india/sale endpoint by using the HTTP method POST. This endpoint belongs to the following group of endpoints for the online banking payments: /v2/payment/banks/{payment_method}/sale.
2. The following objects and parameters must be specified in any request:
   • general—object with general request information:
     • project_id—project ID obtained from Monetix
     • 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.
   • customer—object with customer information:
     • id—the unique ID of the customer within your project
     • ip_address—IP address of the customer's device
     • first_name—customer first name
     • last_name—customer last name
     • email—customer email address
   • account—object with customer account information:
     • bank_id—bank identifier
   • payment—object with payment information:
     • amount—purchase amount in minor currency units without any decimal point or comma except for cases where the currency does not have any minor currency units. If the currency has no minor units (that is, the number of digits for minor currency units is zero), then you must set this parameter to the amount in the major currency units. For the information on whether the currency has any minor units, see Currency codes.
     • currency—code of purchase currency in the ISO-4217 alpha-3 format
   • return_url—object with the information where to redirect the customer to when the payment is completed or prematurely terminated by the customer:
     • success—the URL to redirect the customer to after the payment is successfully completed
     • return—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.
3. Depending on the provider processing the payment, it can be necessary to specify the customer phone number in the phone parameter of the customer object. The phone number must consist of 10 digits or 12—including 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.
4. The following parameter with the return URL is optional, but we strongly advise you to specify it in the request to provide your customer a better user experience.
   • return_url—object with the information where to redirect the customer to when the payment is completed or prematurely terminated by the customer:
     • decline—the URL to redirect the customer to after the payment is declined.
5. If required, you can also add any other additional parameters Gate supports.

Here is an example of data from 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": "911234567890",
        "ip_address": "198.51.100.47",
        "id": "customer1"
    },
    "payment": {
        "amount": 1500,
        "currency": "INR"
    },
    "return_url": {
        "success": "https://example.com/success/",
        "decline": "https://example.com/decline/",
        "return": "https://example.com/return/"
    }
}

Format of customer redirection data

After receiving and processing your purchase request, the payment platform sends a callback to your web service containing the data to redirect the customer to the bank 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 be sent in the request body
• method—the HTTP method to get an HTML page of the website (for example, POST or GET)
• encrypted—this is the service parameter. Ignore the data it contains.

Here is an example of a piece of callback containing 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 format

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

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

{
        "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.

{
        "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:

• Integration procedure
• Payment types, operations and payments
• Signature generation and verification
• Operation statuses and response codes

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 Monetix URL, Gate accepts the request and redirects to the payment platform for further processing. The full sequence of the refund process is provided below.

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

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:
   • general—object with general request information:
     • project_id—the project ID obtained from Monetix
     • 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.
   • payment—object with refund information:
     • description—comment or description
     • amount—refund amount in minor currency units without any decimal point or comma except for cases where the currency does not have any minor currency units. If the currency has no minor units (that is, the number of digits for minor currency units is zero), then you must set this parameter to the amount in the major currency units. For the information on whether the currency has any minor units, see Currency codes.

       The parameter is required only for partial refund.

     • currency—refund currency in ISO-4217 alpha-3 format.

       The parameter is required only for partial refund.

3. If required, you can also add any other additional parameters Gate supports.

Here is an example of data from a refund request in the Banks of India method.

{
  "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 in Gate.

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

{
        "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.

{
        "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:

• Integration procedure
• Signature generation and verification
• Payment types, operations and payments
• Operation statuses and response codes

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 Monetix URL, and receives a callback with the payment result. The full sequence of the payout process is provided below.

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

1. You initiate a payout by sending a payout request to the /v2/payment/banks/india/payout endpoint by using the HTTP method POST. This endpoint belongs to the following group of endpoints for the online banking payments: /v2/payment/banks/{payment_method}/payout.
2. The following objects and parameters must be specified in any request:
   • general—object with general request information:
     • project_id—the project ID obtained from Monetix
     • 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.
   • payment—object with payout information:
     • amount—payout amount in minor currency units without any decimal point or comma except for cases where the currency does not have any minor currency units. If the currency has no minor units (that is, the number of digits for minor currency units is zero), then you must set this parameter to the amount in the major currency units. For the information on whether the currency has any minor units, see Currency codes.
     • currency—payout currency in the ISO-4217 alpha-3 format
   • customer—object with customer information:
     • id—customer identifier on the web service side
     • ip_address—IP address
     • first_name—first name
     • last_name—last name
     • phone—phone number. It must consist of 10 digits, or 12 digits—including the country code of India (91). Depending on the payment processing provider, the parameter may not be mandatory. For more information, refer to your Monetix key account manager.
     • email—email address
     • address—address of residence
   • account—object with the recipient account information:
     • number—recipient account number
     • bank_code—Indian Financial System Code (IFSC) of the branch. The official register can be used to determine the code. Examples of such codes can be found in this file.
     • bank_id—bank identifier. Depending on the payment processing provider, the parameter may not be mandatory For more information, refer to your Monetix key account manager.
3. If required, you can also add any other additional parameters Gate supports.

Here is an example of data from 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": "198.51.100.47",
      "first_name": "John",
      "last_name": "Waynen",
      "phone": "911234567890",
      "email": "waynen@example.com",
      "address": "99, Chakla Street, Masjid Bunder (east)"
  },
  "account": {
      "bank_code": "BKID0000001",
      "bank_id": 408,
      "number": "5588994446666"
  }
}

Callback format

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

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

{
        "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.

{
        "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:

• Integration procedure
• Signature generation and verification
• Payment types, operations and payments
• Operation statuses and response codes

• single payout—you specify the currency and amount for a payout available for this method and fill in all the fields required for the selected payment method on the Dashboard pages.
• as a part of a mass payment—all the parameters are specified in a CSV file. Refer to the Payouts by using Gate section for the parameters required by your payment method.

Information about completed payouts is available for viewing in the Payments and Manual Payments sections of Dashboard.

For more information about payout processing by using Dashboard, see Performing payouts.

As with other payment methods Monetix offers, when using this method, you have several options to analyze the information about payments and operations.

You can load and analyze all the necessary information in Dashboard (dash-light.trxhost.com), for instance you can use the analytic panels in the Analytics section for this purpose.

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 format by using the tools in the Reports section. You can perform export as a one-time or regular download of data to your local computer.
• 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 means of sending requests to the /operations/get endpoint.

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