Documentation

Initiate Payout

Use this endpoint to initiate a payout to a beneficiary bank account or UPI ID.

Endpoint

POST /payout/initiate

Request Headers

Authorization: Bearer <YOUR_API_KEY>
Content-Type: application/json

Request Body

{
  "client_ref_id": "unique_txn_123",
  "beneficiary_name": "David Peter",
  "beneficiary_account": "1234567890",
  "beneficiary_ifsc": "HDFC0001234",
  "amount": 1000.00,
  "transfer_mode": "IMPS",
  "remarks": "Salary payment"
}

Parameters

Parameter	Type	Required	Description
`client_ref_id`	string	Yes	Unique transaction reference from your system
`beneficiary_name`	string	Yes	Name of the beneficiary
`beneficiary_account`	string	Yes	Bank account number
`beneficiary_ifsc`	string	Yes	Bank IFSC code
`amount`	number	Yes	Amount in INR
`transfer_mode`	string	Yes	IMPS, NEFT, RTGS, or UPI
`remarks`	string	No	Transaction remarks

Response

{
  "status": "success",
  "message": "Payout initiated successfully",
  "data": {
    "txn_id": "ZTK123456789",
    "client_ref_id": "unique_txn_123",
    "status": "PENDING",
    "amount": 1000.00,
    "utr": null,
    "created_at": "2025-01-13T10:30:00Z"
  }
}

Status Codes

200 - Payout initiated successfully
400 - Invalid request parameters
401 - Unauthorized - Invalid API key
402 - Insufficient balance
429 - Rate limit exceeded
500 - Internal server error