Payout

When performing a payout, the customer initiates a payout and then just waits for the funds to be credited to their account. The customer themself doesn't participate in the payout processing procedure.

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

Depending on the provider, payouts can be processed during the provider's working hours: Monday to Friday from 10:30 to 19:00 (GMT+8). During weekends and non-working hours, payouts are not processed. For more information, refer to your Monetix key account manager.

Operations support

Interfaces
Payment Page Gate Dashboard
Payout

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.

Payout by using Gate

General information

To perform a payout 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. Accept the callback with the payout result from the payment platform.

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

Figure 1. Payout processing flow when performing a payout by using Gate
  1. The customer initiates a payout in your system.
  2. Your system sends the payout 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 payout result.
  6. The payment platform sends a callback with the payout result to your system.
  7. Your system sends the payout result to the customer.

Request

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

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

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

✱—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
strictly required✱

Customer phone number, consisting of 10 digits or 12 digits—if the number includes the country code of India (91).

Example: 910123456789

address
string
strictly required

Customer's address (street, building number, apartment number, etc.). The address must contain only letters, numbers and whitespace characters.

Example: 99, Chakla Street, Masjid Bunder (east)

account
object
strictly required

number
integer
strictly required

Customer's account number

Example: 1000

bank_id
string
strictly required✱

Bank identifier. Depending on the payment processing provider, the parameter may not be mandatory. For more information, refer to your Monetix key account manager.

Example: 408

bank_code
string
strictly required

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.

Example: BKID0000001

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

You can also add any other optional parameters to the payout 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 payout with the Banks of India payment method:

Figure 2. Example of the payout 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",
        "address": "99, Chakla Street, Masjid Bunder (east)"
    },
    "account": {
        "number": 1000,
        "bank_id": "408",
        "bank_code": "BKID0000001"
    },
    "payment": {
        "currency": "INR",
        "amount": 1000
    }
}

Callback

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

Callbacks for this method include account.number parameter that contains customer's account number.

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

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

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

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

Related topics

Payout 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:
  • 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.

Banks available for payout

Supported banks

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

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

Table 2. Banks available for payout
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
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

The list of banks may change that's why we recommend that you send the payment platform a request for the list of banks currently available in the Banks of India payment method. The request format and structure should be the following:

HTTP request method POST
Request body format JSON
API endpoint /v2/info/banks/india/payout/list
Full API endpoint specification /v2/info/banks/{parentMethod}/{childMethod}/{operationType}/list
Table 3. 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 payout 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 5. 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 6. 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
            }
        ]
    }
]