[DEPRECATED] Withdrawals in V1 API

Crypto

Creates a withdrawal request (V1).

Creates a withdrawal request to an external resource.

Access to this endpoint requires a valid API key. The API key is sent in the x-api-key header on requests.

post

/withdrawal

Authorizations

Body

any of

• The input that contains the request data.

Crypto:

• applicationId - The associated application ID in the external system.
• orderId - The associated order ID in the external system.
• customerId - The customer ID in the external system.
• currency - The currency of a withdrawal.
• address - The recipient address.
• amount - The amount to be withdrawn.

Peer-to-peer:

• applicationId - The associated application ID in the external system.
• orderId - The associated order ID in the external system.
• customerId - The customer ID in the external system.
• currency - The currency of a withdrawal.
• recipient - The recipient, if the free form is selected.
• amount - The amount to be withdrawn.
• bankAccountName - The bank account name, if the bank account transfer is selected.
• bankAccountNumber - The bank account number, if the bank account transfer is selected.
• bankName - The bank name, if the bank account or phone number transfer is selected.
• cardHolderName - The card holder name, if the card transfer is selected.
• cardNumber - The card number, if the card transfer is selected.
• phoneNumber - The phone number, if the phone number transfer is selected.
• comment - The additional comment.

Bank transfer:

• Unsupported.

Peer-to-peer2:

• applicationId - The associated application ID in the external system.
• orderId - The associated order ID in the external system.
• customerId - The customer ID in the external system.
• currency - The currency of a withdrawal (INR).
• amount - The amount to be withdrawn.
• beneficiaryAccountNumber - The bank account number of the beneficiary.
• beneficiaryIfsc - The IFSC code of the beneficiary's bank branch.
• beneficiaryMobileNumber - The mobile number of the beneficiary, required for mobile-based transactions.
• beneficiaryName - The full name of the beneficiary as registered in their bank.
• beneficiaryVpa - Optional Virtual Payment Address (VPA) for UPI transactions.
• purpose - Description of the purpose of the transaction.
• transferMode - Specifies the mode of transfer such as IMPS, RTGS, or UPI.
• comment - Only applicable for RTGS transactions. Special characters are not allowed.

Responses

application/json

application/json

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.xgateway.tech/api/v1/withdrawal' \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{"customerId":"text","currency":"BTC","amount":"text","address":"text"}'

201

400

401

402

404

422

500

201

{
  "data": "The transaction has been initiated. You will be notified once its status has changed.",
  "success": true
}

Created

Using a free-form

Initiates withdrawal of fiat funds using a free-form (v1)

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

Headers

Name	Type	Description
x-api-key*	String	Your API key

Request Body

Name	Type	Description
customerId*	String	The unique customer ID who initiated the withdrawal
amount*	String	The amount to withdraw
currency*	String	The currency to withdraw in
orderId	String	The unique order ID in your system
applicationId	String	The application ID if you have multiple
comment	String	The comment (max 255 symbols)
paymentSystem	String	The payment system to process withdrawal with
recipient*	String	The recipient information

Using a card

Initiates withdrawal of fiat funds using a card (v1)

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

Headers

Name	Type	Description
x-api-key*	String	Your API key

Request Body

Name	Type	Description
customerId*	String	The unique customer ID who initiated the withdrawal
amount*	String	The amount to withdraw
currency*	String	The currency to withdraw in
orderId	String	The unique order ID in your system
applicationId	String	The application ID if you have multiple
comment	String	The comment (max 255 symbols)
paymentSystem	String	The payment system to process withdrawal with
cardHolderName	String	The name on the card to withdraw to
cardNumber*	String	The card number to withdraw to

Using a phone number

Initiates withdrawal of fiat funds using a phone number (v1)

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

Headers

Name	Type	Description
x-api-key*	String	Your API key

Request Body

Name	Type	Description
customerId*	String	The unique customer ID who initiated the withdrawal
amount*	String	The amount to withdraw
currency*	String	The currency to withdraw in
orderId	String	The unique order ID in your system
applicationId	String	The application ID if you have multiple
comment	String	The comment (max 255 symbols)
paymentSystem	String	The payment system to process withdrawal with
phoneNumber*	String	The recipient phone number
bankName	String	The bank name, where there's an account with the provided phone number

Using a bank account

Initiates withdrawal of fiat funds using a bank account (v1)

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

Headers

Name	Type	Description
x-api-key*	String	Your API key

Request Body

Name	Type	Description
customerId*	String	The unique customer ID who initiated the withdrawal
amount*	String	The amount to withdraw
currency*	String	The currency to withdraw in
orderId	String	The unique order ID in your system
applicationId	String	The application ID if you have multiple
comment	String	The comment (max 255 symbols)
paymentSystem	String	The payment system to process withdrawal with
bankName	String	The bank name
bankAccountName*	String	The bank account name
bankAccountNumber*	String	The bank account number