Payouts API

Create Payout

Initiate a payout to a bank account.

POST https://api.payvanta.in/payout

Request Body

Field	Type	Required	Description
`order_id`	string	Yes	Unique order ID for the payout (max 15 digits)
`amount`	string	Yes	Amount in INR
`account_number`	string	Yes	Beneficiary bank account number
`ifsc`	string	Yes	Bank IFSC code
`beneficiaryName`	string	Yes	Name of the beneficiary
`mobile_no`	string	Yes	Mobile number of the beneficiary

Validation Rules

order_id: Must be unique and cannot exceed 15 digits
amount: Must be a positive number
account_number: Must be a valid bank account number
ifsc: Must be a valid IFSC code
beneficiaryName: Must match bank account holder name
mobile_no: Must be a valid mobile number

Response

{
    "success": true,
    "message": "PAYOUT_INITIATED",
    "data": {
        "order_id": "987654321098765",
        "amount": "99",
        "status": "PENDING",
        "chargeAmount": 15.6,
        "gstAmount": 2.81,
        "totalCharge": 18.41,
        "totalDeducted": 117.41
    }
}

Path Parameters

Parameter	Type	Required	Description
`order_id`	string	Yes	Order ID of the payout

Response

{
    "success": true,
    "message": "PAYOUT_DETAILS",
    "data": {
        "order_id": "987654321098765",
        "amount": "99",
        "status": "SUCCESS",
        "beneficiary_name": "Jason Stathom",
        "account_number": "390000000003",
        "utr": "UTR24031545789",
        "chargeAmount": 15.6,
        "gstAmount": 2.81,
        "totalCharge": 18.41,
        "totalDeducted": 117.41,
        "created_at": "2024-03-20T10:00:00Z",
        "completed_at": "2024-03-20T10:30:00Z"
    }
}

Payout Status

Status	Description
`PENDING`	Payout has been initiated
`SUCCESS`	Payout completed successfully
`FAILED`	Payout failed

Payment Modes

PayVanta automatically selects the optimal payment mode (IMPS/NEFT/RTGS) based on the amount and bank status.

Error Codes

Code	Description
`INVALID_ORDER_ID`	Order ID cannot exceed 15 digits
`INVALID_AMOUNT`	Invalid payout amount
`INSUFFICIENT_BALANCE`	Insufficient wallet balance
`INVALID_ACCOUNT`	Invalid bank account details
`INVALID_IFSC`	Invalid IFSC code
`PAYOUT_FAILED`	Payout processing failed
`BENEFICIARY_NOT_FOUND`	Beneficiary details not found

Rate Limits

Endpoint	Limit
Create payout	30/min
Get payout	100/min
List payouts	100/min

Status Balance Check