Skip to content

IMPS

QP Integration option

This integration option supports the following operations:

Payout

Request

Send a payout request with the following additional parameters:

Parameter Type Description
method object A section of the payment method information.
type * required
 string imps
account * required
 string The IMPS account number for a payout.
account_name * required
 string The IMPS account name for a payout.
ifsc_code * required
 string The IMPS IFSC code for a payout.
customer object A section of the customer details.
first_name * required
 string The customer's first name.
last_name * required
 string The customer's last name.
email * required
 string The customer's email address.
address * required
 string The customer's address.
phone * required
 string 10 digits of the customer's phone number without the country code.
Response

The imps response section will have the parameters copied from the request.

EA Integration option

This integration option supports the following operations:

Payout

Request

Send a payout request with the following additional parameters:

Parameter Type Description
method object A section of the payment method.
type * required
 string imps
sender_wallet_id * required
 string The wallet ID (phone number) of the payout sender.
account * required
 string The bank account number of the payout recipient.
bank_name string The bank name of the payout recipient.
ifsc_code * required
 string The IFSC-code of the recipient bank.
customer object A section of the customer's details.
first_name * required
 string The customer's first name.
last_name * required
 string The customer's last name.
phone * required
 string 10 digits of the recipient's phone number, without the country code.
address * required
 string The recipient's address.
zip * required
 string The recipient's zip code.

Info

The payout amount should be in the range from 100 to 200000 INR.

Response

The imps response section will have parameters copied from the request.

OS Integration option

This integration option supports the following operations:

Payout

Request

Send a payout request with the following additional parameters:

Parameter Type Description
method object A section of the payment method information.
type * required
 string imps
account * required
 string The customer's account number.
ifsc_code * required
 string The customer's IFSC code.
customer object A section of the customer details.
first_name * required
 string The customer's first name.
last_name string The customer's last name.
phone * required
 string 10 digits of the customer's phone number, without the country code.
Response

The response will have the imps section with the payment method parameters.

Status query

If you specified notification_url in the payout request, Constantpos sends a webhook notification with the transaction status. Please note, it might take some time for Constantpos to get the transaction status confirmation from the payment method provider.

Request

If needed, send a status query request to get the current transaction status.

Response

The response contains the transaction status, a section of the payment method parameters as well as other details related to the transaction, as described in a status query.

PF Integration option

This integration option supports the payout transaction:

Payout

Request

Send a payout request with the following additional parameters:

Parameter Type Description
method object A section of the payment method information.
type * required
 string imps
account * required
 string The IMPS account number for a payout.
bank_name * required
 string The bank name of the payout recipient.
ifsc_code * required
 string The IFSC-code of the recipient bank.
account_name * required
 string The name of the IMPS account holder.
customer * required
 object A section of information about the customer.
first_name * required
 string The customer's first name.
last_name * required
 string The customer's last name.
address * required
 string The customer's address.
state * required string (2) The customer's billing state. Set as the 2 last symbols of the code in the ISO 3166-2 format.
city * required string (100) The customer's billing city.
zip * required string The post code of the customer's billing address.
phone string (14) The customer's phone number.
email string The customer's email address.
Request example 
{
    "request":{
        "amount":30000,
        "currency":"INR",
        "description":"description",
        "test": true,
        "language":"en",
        "notification_url":"https://merchant.ltd/notification",
        "customer":{
            "first_name":"John",
            "last_name":"Doe",
            "city":"Delhi",
            "zip":"96002",
            "address":"1st Street",
            "state": "DL"
        },
        "method":{
            "type":"imps",
            "account": "123456789",
            "account_name": "John Doe",
            "ifsc_code": "ABCD0001234",
            "bank_name": "BANK0000123"
        }
    }
}
Response

The response will contain the imps section with the payment method parameters.

Response example 
{
    "transaction": {
        "uid": "e1236a41-b26c-489e-a0ea-3419aab1e123",
        "type": "payout",
        "status": "pending",
        "amount": 30000,
        "currency": "INR",
        "description": "description",
        "created_at": "2023-06-02T09:33:13Z",
        "updated_at": "2023-06-02T09:33:15Z",
        "method_type": "imps",
        "receipt_url": "https://my.constantpos.com/customer/transactions/e4bb6a41-b26c-489e-a0ea-3419aab1e7c2/6842440302ab6927e88198c825c458d36a852e9dba8d44b980689d8fe8b112cb?language=en",
        "payout": {
            "status": "pending",
            "gateway_id": 1234,
            "ref_id": "4322647",
            "message": "Transaction was initialized"
        },
        "imps": {
            "type": "imps",
            "account": "123456789",
            "account_name": "John Doe",
            "ifsc_code": "ABCD0001234",
            "bank_name": "BANK0000123"
        },
        "customer": {
            "email": null,
            "ip": null
        },
        "message": "Transaction was initialized",
        "tracking_id": "your_uniq_number",
        "test": true,
        "language": "en",
        "billing_address": {
            "first_name": "John",
            "last_name": "Doe",
            "country": "IN",
            "state": "DL",
            "city": "Delhi",
            "zip": "96002",
            "address": "1st Street"
        },
        "additional_data": {
            "payment_method": {
                "type": "alternative"
            }
        }
    }
}

PFR Integration option

This integration option supports the payout transaction type:

Payout

Payout flow

  1. Merchant forms the payout request to Constantpos containing amount, account_name, account and ifsc_code.
  2. Constantpos responds with a pending status (transaction is being processed) or with an error.
  3. Once the transaction is processed, Constantpos sends a webhook notification to the merchant with a final transaction status (success or declined).
  4. Constantpos sends email notification about the payout status to the merchant and to the customer if the corresponding options are enabled in the settings.

Info

Due to provider server slowdowns, it is not recommended to make payouts between 9 PM and 11 PM IST (03:30—05:30 PM UTC).

Request

Send a payout request with the following additional parameters:

Parameter Type Description
method object A section of the payment method information.
type * required
 string imps
account_name * required
 string (50) The name of the recipient bank account holder.
account * required
 string (50) The bank account number for the payout.
ifsc_code * required
 string The IFSC-code of the recipient bank.

Info

The allowed payout amount range is 500—200000 Indian rupees. The value in the `amount` field must be specified in minimal currency units. For example 500 INR must be sent as 50000.
Request example 
{
    "request":{
        "amount":50001,
        "currency":"INR",
        "description":"description",
        "test": false,                       
        "method":{
            "type":"imps",
            "account": "123456789",                
            "ifsc_code": "ABCD0001234",
            "account_name": "John Doe"               
        }
    }
}
Response

The response will contain the imps section with the payment method parameters sent in the request.

Response example 
{
    "transaction": {
        "uid": "e8db4800-500a-46d7-b3fc-9f0068975458",
        "type": "payout",
        "status": "pending",
        "amount": 50001,
        "currency": "INR",
        "description": "description",
        "created_at": "2023-07-26T15:03:42Z",
        "updated_at": "2023-07-26T15:03:43Z",
        "method_type": "imps",
        "receipt_url": "https://my.constantpos.com/customer/transactions/e8db4900-500a-46d7-b3fc-9f0068975458/7f20310d5d02582ff3afg3db9c26a67906b0684a9a61dc41f3147f04e1068e79?language=en",
        "payout": {
            "status": "pending",
            "gateway_id": 3031,
            "ref_id": "b0c1c9f926e17a6dcb097658214a7b",
            "message": "Initialized"
            },
        "imps": {
            "type": "imps",
            "account": "123456789",
            "account_name": "John Doe",
            "ifsc_code": "ABCD0001234"
            },
        "customer": {
            "email": null,
            "ip": null
            },
        "message": "Initialized",
        "test": true,
        "language": "en",
        "additional_data": {
            "payment_method": {
                "type": "alternative"
            }
        }
    }
}

EAN Integration option

Payout

Payout flow

  1. The customer initiates the payout.
  2. The merchant sends a payout request to the Constantpos system.
  3. Constantpos sends a response to the payout request to the merchant.
  4. Constantpos sends a webhook notification to the merchant with the transaction result.
Request

Send a payout request with the following additional parameters:

Parameter Type Description
method object A section of the payment method information.
type * required
 string imps
account_number * required
 string The bank account number for the payout recipient.
ifsc_code * required
 string The IFSC-code of the recipient bank.
bank_name string The bank name of the payout recipient.
customer object A section of the customer details.
first_name * required
 string (35) The customer's first name.
last_name * required
 string (35) The customer's last name.
Request example 
{
    "request": {
        "amount": 1000,
        "currency": "INR",
        "description": "description",
        "test": false,       
        "customer": {
            "first_name": "John",
            "last_name": "Doe"            
        },
        "method": {
            "type": "imps",
            "account_number": "50322135136578",
            "ifsc_code": "HDFC325",
            "bank_name": "BANK0000123"
        }
    }
}
Response

The response will contain the imps section with the payment method parameters sent in the request.

Response example 
{
    "transaction": {
        "uid": "7e5313d5-9e20-4baa-8ffb-8401d1ca0cd7",
        "type": "payout",
        "status": "pending",
        "amount": 1000,
        "currency": "INR",
        "description": "description",
        "created_at": "2023-12-14T10:17:45Z",
        "updated_at": "2023-12-14T10:17:45Z",
        "manually_corrected_at": null,
        "method_type": "imps",
        "receipt_url": "https://my.constantpos.com/customer/transactions/7e5313d5-9e20-4baa-8ffb-8401d1ca0cd7/8b08db25d1dbbdeb7ba122ce13362ab479421e013dcb19e7da5f22dd313ead48",
        "payout": {
            "status": "pending",
            "gateway_id": 3523,
            "ref_id": "7e5313d5-9e20-4baa-8ffb-8401d1ca0cd7",
            "message": "010 SUCCESS"
        },
        "imps": {
            "type": "imps",
            "account_number": "50322135136578",
            "ifsc_code": "HDFC325",
            "bank_name": "BANK0000123"
        },
        "customer": {
            "email": null,
            "ip": null
        },
        "message": "010 SUCCESS",
        "test": false,
        "billing_address": {
            "first_name": "John",
            "last_name": "Doe"
        },
        "additional_data": {
            "payment_method": {
                "type": "alternative"
            }
        }           
    }
}

II Integration option

Payout

Payout flow

  1. The customer initiates the payout.
  2. The merchant sends a payout request to the Constantpos system.
  3. Constantpos sends a response to the payout request to the merchant.
  4. Constantpos sends a webhook notification to the merchant with the transaction result.
Request

Send a payout request with the following additional parameters:

Parameter Type Description
method object A section of the payment method information.
type * required
 string imps
account * required
 string The bank account number for the payout recipient.
ifsc_code * required
 string The IFSC-code of the recipient bank.
bank_name * required
 string The bank name of the payout recipient.
customer object A section of the customer details.
first_name * required
 string (35) The customer's first name.
last_name * required
 string (35) The customer's last name.
phone * required
 string The customer's phone number.
Request example 
{
  "request": {
    "amount": 20000,
    "currency": "INR",
    "description": "description",
    "test": false,
    "return_url": "https://someurl.com",
    "customer": {
      "first_name": "John",
      "last_name": "Doe",
      "phone": "123789105"
    },
    "method": {
      "type": "imps",
      "bank_name": "Bank",
      "ifsc_code": "HDFC325",
      "account": "11185058447"
    }
  }
}
Response

The response will contain the imps section with the payment method parameters sent in the request.

Response example 
{
  "transaction": {
    "uid": "5063c831-0ba0-485b-a0d8-d1314256a486",
    "type": "payout",
    "status": "pending",
    "amount": 20000,
    "currency": "INR",
    "description": "description",
    "created_at": "2023-12-26T08:38:49Z",
    "updated_at": "2023-12-26T08:38:49Z",
    "manually_corrected_at": null,
    "method_type": "imps",
    "receipt_url": "https://my.constantpos.com/customer/transactions/5063c831-0ba0-485b-a0d8-d1314256a486/592d7b97f3e21a46c19317b406834e6593e391a0a8669eb0575612db138886dc",
    "payout": {
      "status": "pending",
      "gateway_id": 3559,
      "message": "Transaction was initialized.",
      "bank_code": "0001"
    },
    "imps": {
      "type": "imps"
    },
    "customer": {
      "email": null,
      "ip": null
    },
    "message": "Transaction was initialized.",
    "test": false,
    "billing_address": {
      "first_name": "John",
      "last_name": "Doe",
      "phone": "123789105"
    },
    "additional_data": {
      "payment_method": {
        "type": "alternative"
      }
    }
  }
}

GP Integration option

Payout

Payout flow

  1. The customer initiates the payout.
  2. The merchant sends a payout request to the Constantpos system.
  3. Constantpos sends a response to the payout request to the merchant.
  4. Constantpos sends a webhook notification to the merchant with the transaction result.
Request

Send a payout request with the following additional parameters:

Parameter Type Description
request object
amount * required
 bigInteger Transaction amount, must be an integer amount specified in minimal currency units, for example, 50000 (500 rupees). The submitted value must end in 00.
method object A section of the payment method information.
type * required
 string imps
account_number * required
 string The bank account number for the payout recipient.
ifsc_code * required
 string The IFSC-code of the recipient bank.
customer object A section of the customer details.
first_name * required
 string The customer's first name.
last_name * required
 string The customer's last name.
phone string (10) The customer's phone number. Must be 10 digits.
Request example 
{
  "request": {
    "amount": 20000,
    "currency": "INR",
    "description": "description",
    "test": false,
    "customer": {
      "first_name": "John",
      "last_name": "Doe"
    },
    "method": {
      "type": "imps",
      "ifsc_code": "ICIC0000739",
      "account_number": "947889674934"
    }
  }
}
Response

The response will contain the imps section with the payment method parameters sent in the request.

Response example 
{
  "transaction": {
    "uid": "65358109-b585-481f-849e-65db68168a89",
    "type": "payout",
    "status": "pending",
    "amount": 20000,
    "currency": "INR",
    "description": "description",
    "created_at": "2023-12-27T10:59:11Z",
    "updated_at": "2023-12-27T10:59:15Z",
    "manually_corrected_at": null,
    "method_type": "imps",
    "receipt_url": "https://my.constantpos.com/customer/transactions/65358109-b585-481f-849e-65db68168a89/f47f5172243d59afa5278f5222bd565d1b7d0514f455ed720a12a73fb9198fc4",
    "payout": {
      "status": "pending",
      "gateway_id": 3564,
      "ref_id": "LQNNYJTC0DIDP9W7CIF0YG59LUXF40P",
      "message": "Transaction was initialized.",
      "bank_code": "200"
    },
    "imps": {
      "type": "imps"
    },
    "customer": {
      "email": null,
      "ip": null
    },
    "message": "Transaction was initialized.",
    "test": false,
    "billing_address": {
      "first_name": "John",
      "last_name": "Doe"
    },
    "additional_data": {
      "payment_method": {
        "type": "alternative"
      }
    }
  }
}