Chilkat Online Tools

lianja / Razorpay APIs / Create Payout-VPA

Back to Collection Items

// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

loHttp = createobject("CkHttp")

loHttp.BasicAuth = .T.
loHttp.Login = "username"
loHttp.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": "UPI",
//   "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."
//   }
// }

loJson = createobject("CkJsonObject")
loJson.UpdateString("account_number","7878780080316316")
loJson.UpdateString("fund_account_id","fa_00000000000001")
loJson.UpdateInt("amount",1000000)
loJson.UpdateString("currency","INR")
loJson.UpdateString("mode","UPI")
loJson.UpdateString("purpose","refund")
loJson.UpdateBool("queue_if_low_balance",.T.)
loJson.UpdateString("reference_id","Acme Transaction ID 12345")
loJson.UpdateString("narration","Acme Corp Fund Transfer")
loJson.UpdateString("notes.notes_key_1","Tea, Earl Grey, Hot")
loJson.UpdateString("notes.notes_key_2","Tea, Earl Grey… decaf.")

loHttp.SetRequestHeader("Content-Type","application/json")
loHttp.SetRequestHeader("X-Dashboard-User-Role","owner")
loHttp.SetRequestHeader("Authorization","{{apiPrivateAuth}}")
loHttp.SetRequestHeader("X-Payout-Idempotency","")
loHttp.SetRequestHeader("X-Dashboard-User-Id","20000000000000")

loResp = loHttp.PostJson3("https://api.razorpay.com/v1/payouts","application/json",loJson)
if (loHttp.LastMethodSuccess = .F.) then
    ? loHttp.LastErrorText
    release loHttp
    release loJson
    return
endif

? str(loResp.StatusCode)
? loResp.BodyStr
release loResp


release loHttp
release loJson

Curl Command

curl -X POST
	-u 'username:password'
	-H "X-Payout-Idempotency: "
	-H "Content-Type: application/json"
	-H "Authorization: {{apiPrivateAuth}}"
	-H "X-Dashboard-User-Id: 20000000000000"
	-H "X-Dashboard-User-Role: owner"
	-d '{
  "account_number": "7878780080316316",
  "fund_account_id": "fa_00000000000001",
  "amount": 1000000,
  "currency": "INR",
  "mode": "UPI",
  "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": "Create Payout-VPA",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "X-Payout-Idempotency",
        "value": "",
        "type": "text",
        "disabled": true
      },
      {
        "key": "Content-Type",
        "value": "application/json"
      },
      {
        "key": "Authorization",
        "value": "{{apiPrivateAuth}}"
      },
      {
        "key": "X-Dashboard-User-Id",
        "value": "20000000000000",
        "disabled": true
      },
      {
        "key": "X-Dashboard-User-Role",
        "value": "owner",
        "disabled": true
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"account_number\": \"7878780080316316\",\n  \"fund_account_id\": \"fa_00000000000001\",\n  \"amount\": 1000000,\n  \"currency\": \"INR\",\n  \"mode\": \"UPI\",\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}"
    },
    "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/payouts/#vpa-upi-id) to create a payout to a VPA."
  },
  "response": [
  ]
}