Skip to content

Create payout

API TEST CONSOLE

Test request

TEST ONLY

Configure parameters and send a request to the test environment

POST/trade/payout/create

Authentication

Not configured

The private key is used only in your browser to generate authorization. It is never sent or stored.

Request headers

Request body application/json

Response

Response
After you send the request, the status, duration, and JSON response appear here.

Authentication details remain only in this page's memory and are not written to local storage.

Copying cURL does not send a request

POST/trade/payout/create

Request headers

Common request headers.

Payment method values

payoutType
BANK_TRANSFER
UPI

Request parameters

FieldTypeRequiredMaximum lengthDescription
merchantOrderNoStringYes32Merchant order number
transactionAmountStringYes20Payout amount, an integer or up to two decimal places
payoutTypeStringYes20Payout method
idTypeStringNo32Optional ID type. This endpoint has no fixed enum; omit this field unless required by your business or payment channel.
userIdCardStringNo50ID number. No fixed format; omit this field unless required by your business or payment channel.
userNameStringYes64User name
userPhoneStringYes10User mobile number, 10 digits; starts with 6, 7, 8 or 9
userEmailStringNo50User email
bankCodeStringConditionally required20Required when payoutType is BANK_TRANSFER. Enter the beneficiary bank’s IFSC; see Bank codes.
bankNameStringNo-Bank name, see Bank code description
bankAccountNoStringYes50Beneficiary account. When payoutType is UPI, the account must contain @.
descriptionStringNo100Description
payoutCallbackUrlStringNo200Payout callback URL

Request example

{
"merchantOrderNo": "PAYOUT202609170001",
"transactionAmount": "100.00",
"payoutType": "BANK_TRANSFER",
"userName": "TEST USER",
"userPhone": "6123456789",
"bankCode": "HDFC0000001",
"bankName": "HDFC Bank",
"bankAccountNo": "1234567890"
}

Response parameters

FieldTypeRequiredMaximum lengthDescription
codeintYes-Status code; a value other than 200 indicates an error
dataObjectYes-Response body
data.merchantOrderNoStringYes32Merchant order number
data.tradeNoStringYes32Platform order number
data.transactionAmountStringYes-Payout amount
data.statusStringYes24Order status
data.payoutTypeStringYes24Payout method
msgStringNo-Error message
tidStringYes-Trace ID

Response example

{
"code": 200,
"data": {
"merchantOrderNo": "PAYOUT202609170001",
"tradeNo": "VF2405220001IN0000508467743993",
"transactionAmount": "100.00",
"status": "PAYING",
"payoutType": "BANK_TRANSFER"
},
"msg": "success",
"tid": "747bbf80261844ed85b809212aab0d81"
}