Skip to content

INR Peer to Peer 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, please provide the following parameters in the withdrawal request:

Parameter Mandatory Description
amount true String representation of requested amount
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.
beneficiaryAccountNumber false* Customer's bank account number. Mandatory for `transferMode` = `IMPS`
beneficiaryIfsc false* String representation of the Indian Financial System Code. Mandatory for `transferMode` = `RGTS`
beneficiaryMobileNumber true Customer’s phone number in string format
beneficiaryName true Customer’s first name and last name in string format
beneficiaryVpa false* String representation of the Virtual Payment Address. Mandatory for `transferMode` = `UPI`
purpose true One of the following: Cashbacks, LoyaltyPointsRedemption, Refunds, MarketingCampaign, VendorPayouts
transferMode true

One of the following: IMPS, UPI, RTGS. Please provide "IMPS" at the moment.
Payload example
{
  "amount": "5000",
  "currency": "INR",
  "customerId": "test_customer_id",
  "orderId": "test_order_id",
  "beneficiaryMobileNumber": "+11111111111",
  "beneficiaryName": "John Doe",
  "beneficiaryAccountNumber": "123456789",
  "beneficiaryIfsc": "ASDF0000161",
  "purpose": "VendorPayouts",
  "transferMode": "IMPS"
}

Minimum amount for INR withdrawals is 5000 INR