Chilkat Online Tools

Swift3 / Razorpay APIs / Create Payout-VPA

Back to Collection Items

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

    let http = CkoHttp()!
    var success: Bool

    http.basicAuth = true
    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": "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."
    //   }
    // }

    let json = CkoJsonObject()!
    json.update("account_number", value: "7878780080316316")
    json.update("fund_account_id", value: "fa_00000000000001")
    json.updateInt("amount", value: 1000000)
    json.update("currency", value: "INR")
    json.update("mode", value: "UPI")
    json.update("purpose", value: "refund")
    json.updateBool("queue_if_low_balance", value: true)
    json.update("reference_id", value: "Acme Transaction ID 12345")
    json.update("narration", value: "Acme Corp Fund Transfer")
    json.update("notes.notes_key_1", value: "Tea, Earl Grey, Hot")
    json.update("notes.notes_key_2", value: "Tea, Earl Grey… decaf.")

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

    var resp: CkoHttpResponse? = http.postJson3("https://api.razorpay.com/v1/payouts", contentType: "application/json", json: json)
    if http.lastMethodSuccess == false {
        print("\(http.lastErrorText!)")
        return
    }

    print("\(resp!.statusCode.intValue)")
    print("\(resp!.bodyStr!)")
    resp = nil

}

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": [
  ]
}