VBScript / Razorpay APIs / Idempotent Request
Back to Collection Items
Dim fso, outFile
Set fso = CreateObject("Scripting.FileSystemObject")
'Create a Unicode (utf-16) output text file.
Set outFile = fso.CreateTextFile("output.txt", True, True)
' This example assumes the Chilkat API to have been previously unlocked.
' See Global Unlock Sample for sample code.
' For versions of Chilkat < 10.0.0, use CreateObject("Chilkat_9_5_0.Http")
set http = CreateObject("Chilkat.Http")
http.BasicAuth = 1
http.Login = "username"
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": "7878780080316316",
' "fund_account_id": "fa_00000000000001",
' "amount": 1000000,
' "currency": "INR",
' "mode": "IMPS",
' "purpose": "refund",
' "queue_if_low_balance": true,
' "reference_id": "Acme Transaction ID 12345",
' "narration": "Acme Corp Fund Transfer",
' "notes": {
' "notes_key_1": "Tea, Earl Grey, Hot",
' "notes_key_2": "Tea, Earl Grey… decaf."
' }
' }
' For versions of Chilkat < 10.0.0, use CreateObject("Chilkat_9_5_0.JsonObject")
set json = CreateObject("Chilkat.JsonObject")
success = json.UpdateString("account_number","7878780080316316")
success = json.UpdateString("fund_account_id","fa_00000000000001")
success = json.UpdateInt("amount",1000000)
success = json.UpdateString("currency","INR")
success = json.UpdateString("mode","IMPS")
success = json.UpdateString("purpose","refund")
success = json.UpdateBool("queue_if_low_balance",1)
success = json.UpdateString("reference_id","Acme Transaction ID 12345")
success = json.UpdateString("narration","Acme Corp Fund Transfer")
success = json.UpdateString("notes.notes_key_1","Tea, Earl Grey, Hot")
success = json.UpdateString("notes.notes_key_2","Tea, Earl Grey… decaf.")
http.SetRequestHeader "X-Payout-Idempotency","53cda91c-8f81-4e77-bbb9-7388f4ac6bf4"
' resp is a Chilkat.HttpResponse
Set resp = http.PostJson3("https://api.razorpay.com/v1/payouts","application/json",json)
If (http.LastMethodSuccess = 0) Then
outFile.WriteLine(http.LastErrorText)
WScript.Quit
End If
outFile.WriteLine(resp.StatusCode)
outFile.WriteLine(resp.BodyStr)
outFile.Close
Curl Command
curl -X POST
-u 'username:password'
-H "X-Payout-Idempotency: 53cda91c-8f81-4e77-bbb9-7388f4ac6bf4"
-d '{
"account_number": "7878780080316316",
"fund_account_id": "fa_00000000000001",
"amount": 1000000,
"currency": "INR",
"mode": "IMPS",
"purpose": "refund",
"queue_if_low_balance": true,
"reference_id": "Acme Transaction ID 12345",
"narration": "Acme Corp Fund Transfer",
"notes": {
"notes_key_1":"Tea, Earl Grey, Hot",
"notes_key_2":"Tea, Earl Grey… decaf."
}
}'
https://api.razorpay.com/v1/payouts
Postman Collection Item JSON
{
"name": "Idempotent Request",
"request": {
"method": "POST",
"header": [
{
"key": "X-Payout-Idempotency",
"value": "53cda91c-8f81-4e77-bbb9-7388f4ac6bf4",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"account_number\": \"7878780080316316\",\n \"fund_account_id\": \"fa_00000000000001\",\n \"amount\": 1000000,\n \"currency\": \"INR\",\n \"mode\": \"IMPS\",\n \"purpose\": \"refund\",\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\":\"Tea, Earl Grey, Hot\",\n \"notes_key_2\":\"Tea, Earl Grey… decaf.\"\n }\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://api.razorpay.com/v1/payouts",
"protocol": "https",
"host": [
"api",
"razorpay",
"com"
],
"path": [
"v1",
"payouts"
]
},
"description": "To make a request idempotent, add the header `X-Payout-Idempotency` to the request and pass an idempotency key against it.\n\nAn idempotency key is a unique value generated by you. Our servers use this key to recognize subsequent retries of the same request.\n\nThe idempotency key (4-36 characters) can only contain alphabets, numbers, hyphens, underscores and space. For example, `53cda91c-8f81-4e77-bbb9-7388f4ac6bf4`. We recommend you generate the key using a version 4 (random) UUID generator.\n\nKnow more about [Idempotent Requests](https://razorpay.com/docs/api/razorpayx/idempotency/)."
},
"response": [
]
}