Skip to content

Create Payout

Request

MethodURL
POST/api/pay/payout/create/v1

Request Headers

HeaderDescription
timestampRequest timestamp
nonceRandom value
countryIN
app_codeApplication code

Request Parameters

FieldTypeRequiredMax LengthDescription
merchantOrderNoStringYes32Merchant order number
amountStringYes20Payout amount in INR (integer recommended, currency: INR)
accountTypeIntegerYesโ€”Account type: 1001 = BANK_TRANSFER, 1002 = UPI
bankCodeStringNo*50Bank IFSC code โ€” required when accountType is 1001. Uniquely identifies a bank branch in India. Format: first 4 characters are the bank code (letters, e.g., ICIC for ICICI Bank, SBIN for State Bank of India), 5th character is always 0 (reserved), last 6 characters are the branch code (usually digits, but may include letters). Example: ICIC0000001
bankAccountStringYes50Recipient account number (For UPI payment method, the account must contain at least the @ character.)
realNameStringYes40Userโ€™s full name. No special characters; recommended all uppercase; minimum 2 letters. Strict validation is not enforced, but must follow a normal name format
phoneStringYes10Userโ€™s mobile number โ€” exactly 10 digits, must start with 6, 7, 8, or 9
emailStringNo64Email address
callbackUrlStringNo200Payout callback URL. If omitted, the URL configured in the merchant portal is used
signStringYesโ€”Signature

Request Example

{
"merchantOrderNo": "OrderNoExample",
"amount": "1000",
"accountType": 1001,
"bankCode": "ICIC0000001",
"bankAccount": "1234567890123456789012",
"realName": "realName",
"phone": "6123456789",
"callbackUrl": "https://www.callbackexample.com",
"sign": "YOUR_SIGN"
}

Response Parameters

FieldTypeRequiredDescription
merchantOrderNoStringYesMerchant order number
tradeNoStringYesPlatform order number
statusIntegerYesPayout status: 1 Processing, 3 Failed (can be re-initiated)
amountStringYesTransaction amount

Success Response Example

{
"msg": "success",
"traceId": "747bbf80261844ed85b809212aab0d81.85.17422898158610298",
"code": 200,
"data": {
"amount": "1000.00",
"merchantOrderNo": "OrderNoExample",
"status": 1,
"tradeNo": "TF2501010001AR0000000000000000"
}
}

Error Codes

CodeMessageResolution
412Please try again laterRetry later
414*Correct the corresponding parameter
417Merchant account not foundMerchant account not found; contact us
425Insufficient merchant balanceInsufficient balance in merchant account
426merchant order duplicateChange the merchant order number
427The callback notification address for collection must not be empty.No collection callback URL configured; please configure one
432*Mismatch between card number, bank code, and payment method; check and correct
462This request failed due to blacklist blockingBlacklisted; update parameters and retry
473Merchant joint verification error: *Merchant configuration error; contact us
500Business ErrorContact us

Error Response Example

{
"code": 425,
"data": null,
"msg": "Insufficient merchant balance",
"traceId": "747bbf80261844ed85b809212aab0d81.85.17422898158610298"
}