SQL Server / Razorpay APIs / Composite API - VPA
Back to Collection Items
-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
DECLARE @hr int
DECLARE @iTmp0 int
-- Important: Do not use nvarchar(max). See the warning about using nvarchar(max).
DECLARE @sTmp0 nvarchar(4000)
-- This example assumes the Chilkat API to have been previously unlocked.
-- See Global Unlock Sample for sample code.
DECLARE @http int
-- Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.Http', @http OUT
IF @hr <> 0
BEGIN
PRINT 'Failed to create ActiveX component'
RETURN
END
DECLARE @success int
EXEC sp_OASetProperty @http, 'BasicAuth', 1
EXEC sp_OASetProperty @http, 'Login', 'username'
EXEC sp_OASetProperty @http, 'Password', 'password'
-- Use this online tool to generate code from sample JSON: Generate Code to Create JSON
-- The following JSON is sent in the request body.
-- {
-- "account_number": "account_number",
-- "amount": 10000,
-- "currency": "INR",
-- "mode": "UPI",
-- "purpose": "refund",
-- "fund_account": {
-- "account_type": "vpa",
-- "vpa": {
-- "address": "gauravkumar@exampleupi"
-- },
-- "contact": {
-- "name": "Gaurav Kumar",
-- "email": "gaurav.kumar@example.com",
-- "contact": "9876543210",
-- "type": "employee",
-- "reference_id": "Acme Contact ID 12345",
-- "notes": {
-- "notes_key_1": "Tea, Earl Grey, Hot",
-- "notes_key_2": "Tea, Earl Grey… decaf."
-- }
-- }
-- },
-- "queue_if_low_balance": true,
-- "reference_id": "Acme Transaction ID 12345",
-- "narration": "Acme Corp Fund Transfer",
-- "notes": {
-- "notes_key_1": "Beam me up Scotty",
-- "notes_key_2": "Engage"
-- }
-- }
DECLARE @json int
-- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @json OUT
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'account_number', 'account_number'
EXEC sp_OAMethod @json, 'UpdateInt', @success OUT, 'amount', 10000
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'currency', 'INR'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'mode', 'UPI'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'purpose', 'refund'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'fund_account.account_type', 'vpa'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'fund_account.vpa.address', 'gauravkumar@exampleupi'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'fund_account.contact.name', 'Gaurav Kumar'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'fund_account.contact.email', 'gaurav.kumar@example.com'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'fund_account.contact.contact', '9876543210'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'fund_account.contact.type', 'employee'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'fund_account.contact.reference_id', 'Acme Contact ID 12345'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'fund_account.contact.notes.notes_key_1', 'Tea, Earl Grey, Hot'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'fund_account.contact.notes.notes_key_2', 'Tea, Earl Grey… decaf.'
EXEC sp_OAMethod @json, 'UpdateBool', @success OUT, 'queue_if_low_balance', 1
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'reference_id', 'Acme Transaction ID 12345'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'narration', 'Acme Corp Fund Transfer'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'notes.notes_key_1', 'Beam me up Scotty'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'notes.notes_key_2', 'Engage'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'X-Payout-Idempotency', ''
DECLARE @resp int
EXEC sp_OAMethod @http, 'PostJson3', @resp OUT, 'https://api.razorpay.com/v1/payouts', 'application/json', @json
EXEC sp_OAGetProperty @http, 'LastMethodSuccess', @iTmp0 OUT
IF @iTmp0 = 0
BEGIN
EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @json
RETURN
END
EXEC sp_OAGetProperty @resp, 'StatusCode', @iTmp0 OUT
PRINT @iTmp0
EXEC sp_OAGetProperty @resp, 'BodyStr', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @resp
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @json
END
GO
Curl Command
curl -X POST
-u 'username:password'
-H "X-Payout-Idempotency: "
-d '{
"account_number":"account_number",
"amount":10000,
"currency":"INR",
"mode":"UPI",
"purpose":"refund",
"fund_account":{
"account_type":"vpa",
"vpa":{
"address":"gauravkumar@exampleupi"
},
"contact":{
"name":"Gaurav Kumar",
"email":"gaurav.kumar@example.com",
"contact":"9876543210",
"type":"employee",
"reference_id":"Acme Contact ID 12345",
"notes":{
"notes_key_1":"Tea, Earl Grey, Hot",
"notes_key_2":"Tea, Earl Grey… decaf."
}
}
},
"queue_if_low_balance":true,
"reference_id":"Acme Transaction ID 12345",
"narration":"Acme Corp Fund Transfer",
"notes":{
"notes_key_1":"Beam me up Scotty",
"notes_key_2":"Engage"
}
}'
https://api.razorpay.com/v1/payouts
Postman Collection Item JSON
{
"name": "Composite API - VPA",
"request": {
"method": "POST",
"header": [
{
"key": "X-Payout-Idempotency",
"value": "",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"account_number\":\"account_number\",\n \"amount\":10000,\n \"currency\":\"INR\",\n \"mode\":\"UPI\",\n \"purpose\":\"refund\",\n \"fund_account\":{\n \"account_type\":\"vpa\",\n \"vpa\":{\n \"address\":\"gauravkumar@exampleupi\"\n },\n \"contact\":{\n \"name\":\"Gaurav Kumar\",\n \"email\":\"gaurav.kumar@example.com\",\n \"contact\":\"9876543210\",\n \"type\":\"employee\",\n \"reference_id\":\"Acme Contact ID 12345\",\n \"notes\":{\n \"notes_key_1\":\"Tea, Earl Grey, Hot\",\n \"notes_key_2\":\"Tea, Earl Grey… decaf.\"\n }\n }\n },\n \"queue_if_low_balance\":true,\n \"reference_id\":\"Acme Transaction ID 12345\",\n \"narration\":\"Acme Corp Fund Transfer\",\n \"notes\":{\n \"notes_key_1\":\"Beam me up Scotty\",\n \"notes_key_2\":\"Engage\"\n }\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://api.razorpay.com/v1/payouts",
"protocol": "https",
"host": [
"api",
"razorpay",
"com"
],
"path": [
"v1",
"payouts"
]
},
"description": "Use this [API](https://razorpay.com/docs/api/razorpayx/composite-api/#vpa-upi-id) to create a payout using contact and VPA."
},
"response": [
]
}
