Start Deposit
Start a deposit for a specified amount. A successful sumbmission will return status code '201'. Started deposits may be handled with either of the methods outlined below:
Deposit URL
Send users to the 'deposit_url' provided in the response body where they can finish submitting their deposit.
Deposit Submission Form
Use the 'channel_types' in the reponse body to allow users to select (1) a channel type, then (2) A channel type option. Use the selected 'channel_id' to call the 'Submit Deposit' endpoint.
Post <base_url>/v1_0/start-depositRequest Body (JSON)
amount
required
number - Deposit amount in paisa (₹1 = 100)
redirect_url
optional
string - Optionally provide URL for redirecting users after sucessful deposit submissions
Example Responses
200 - OK Response
{
"channel_types": [
{
"name": "UPI",
"type": "upi",
"options": [
{
"type": "upi",
"channel_id": "2184b1c4-4add-4bf7-8888-d4fdf302ef9f",
"upi_address": "asarul22@upi"
},
{
"type": "upi",
"channel_id": "eca9e76f-7d60-4aa6-8974-1553048dfb37",
"upi_address": "testupi1@okicici"
},
{
"type": "upi",
"channel_id": "eca9e26f-7d60-4aa6-8974-1553248d2b37",
"upi_address": "testupi2@okicici"
},
{
"type": "upi",
"channel_id": "eca9e36f-7d60-4aa6-8974-1353248d2337",
"upi_address": "testupi3@okicici"
},
{
"type": "upi",
"channel_id": "eca9e46f-7d60-44a6-8974-1353448d2337",
"upi_address": "testupi4@okicici"
}
]
},
{
"name": "Bank Transfer",
"type": "bank_transfer",
"options": [
{
"type": "bank_transfer",
"channel_id": "d1619a64-8c92-46f1-86e9-64597a8e061f",
"bank_name": "IDFC FIRST BANK",
"bank_account_number": "10177881403",
"bank_ifsc_code": "IDFB0041372"
},
{
"type": "bank_transfer",
"channel_id": "e529c0f1-7789-40ae-86e9-892e3ad52c46",
"bank_name": "Some Bank",
"bank_account_number": "123123123123",
"bank_ifsc_code": "456456"
}
]
},
{
"name": "QR Code",
"type": "qr_code",
"options": [
{
"type": "qr_code",
"channel_id": "d1619a64-8c92-46f1-86e9-6459qr1e061f",
"qr_image": "qr.jpeg",
"qr_name": "Sk Asraul"
}
]
},
{
"name": "QR Code 2",
"type": "qr_code2",
"options": [
{
"type": "qr_code2",
"channel_id": "d1619a64-8c92-46f1-86e9-6459qr2e061f",
"qr_image": "qr2.jpeg",
"qr_name": "QRCode2"
}
]
},
{
"name": "Bank Name",
"type": "bank_name",
"options": [
{
"type": "bank_name",
"channel_id": "d1619a64-8c92-46f1-86e9-6459qr1eaxis",
"bnk_name": "Axis Bank",
"bank_url": "https://www.axisbank.com/"
},
{
"type": "bank_name",
"channel_id": "d1619a64-8c92-46f1-86e9-6459qr1esbi",
"bnk_name": "SBI Bank",
"bank_url": "https://www.onlinesbi.sbi/"
},
{
"type": "bank_name",
"channel_id": "d1619a64-8c92-46f1-86e9-6459qr1hdfc",
"bnk_name": "HDFC Bank",
"bank_url": "https://www.hdfcbank.com/"
},
{
"type": "bank_name",
"channel_id": "d1619a64-8c92-46f1-86e9-6459qr1icici",
"bnk_name": "ICICI Bank",
"bank_url": "https://www.icicibank.com/"
}
]
}
],
"deposit_id": "VGxSQ1ptRklVakJqU0UwMlRIazViR1ZIUm5SalIzaHNURzFPZG1KV09ERk5Samx6WVZoYWJGZ3pUakZaYlRGd1pFaFNiRnBHT0hsTlJFa3dURlJCTTB4VVNURkpSRVUwVDJwUmVrOXFUVEU9",
"deposit_url": "https://example.com/"
}
400 - Bad Request
{
"error": "\"amount\" is required"
}
400 - Bad Request
{
"error": "Amount must be less than ₹2,40,000.00"
}
400 - Bad Request
{
"error": "\"redirect_url\" must be a valid uri"
}