INR Immediate Payment Service withdrawals#

Withdrawal endpoint#

Make a withdrawal request using the API V.2 endpoint (see the withdrawal initiation with API page for the full OpenAPI specification):

POST https://api.xgateway.tech/api/v2/withdrawal

Required Payload#

To initiate a withdrawal in INR currency using IMPS, please provide the following parameters in the withdrawal request:

Parameter	Mandatory	Description
amount	true	The amount to be withdrawn
applicationId	false	Application ID in case the application is used
customerId	true	Customer id in the merchant system
orderId	false	Invoice id in the merchant system. If provided, used as an idempotency key
currency	true	String representation of the requested currency. Should be `INR` in this case
bankAccountName	false	The bank account name, if the bank account transfer is selected (optional)
bankAccountNumber	true	The bank account number, if the bank account transfer is selected
bankName	false	The bank name, if the bank account transfer is selected (optional)
bankIfscCode	true	The IFSC code
paymentSystem	true	String representation of the payment system used. Should be `IMPS` in this case

Fields marked as optional - such as bankAccountName, bankName - may be omitted. However, providing them can improve success rates and reduce processing time.

Payload example

{
  "amount": "5000",
  "customerId": "ceb5a846-0394-4f08-a1de-efa8581ebfc6",
  "orderId": "ceb5a846-1394-4f08-a1de-efa8581xbad9",
  "currency": "INR",
  "bankAccountName": "R V ENTERPRISE",
  "bankAccountNumber": "112233602699",
  "bankName": "STATE BANK OF INDIA",
  "bankIfscCode": "SBIN0001239",
  "paymentSystem": "IMPS"
}