Chilkat Online Tools

Powershell / Razorpay APIs / Composite API - VPA

Back to Collection Items

Add-Type -Path "C:\chilkat\ChilkatDotNet47-x64\ChilkatDotNet47.dll"

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

$http = New-Object Chilkat.Http

$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": "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"
#   }
# }

$json = New-Object Chilkat.JsonObject
$json.UpdateString("account_number","account_number")
$json.UpdateInt("amount",10000)
$json.UpdateString("currency","INR")
$json.UpdateString("mode","UPI")
$json.UpdateString("purpose","refund")
$json.UpdateString("fund_account.account_type","vpa")
$json.UpdateString("fund_account.vpa.address","gauravkumar@exampleupi")
$json.UpdateString("fund_account.contact.name","Gaurav Kumar")
$json.UpdateString("fund_account.contact.email","gaurav.kumar@example.com")
$json.UpdateString("fund_account.contact.contact","9876543210")
$json.UpdateString("fund_account.contact.type","employee")
$json.UpdateString("fund_account.contact.reference_id","Acme Contact ID 12345")
$json.UpdateString("fund_account.contact.notes.notes_key_1","Tea, Earl Grey, Hot")
$json.UpdateString("fund_account.contact.notes.notes_key_2","Tea, Earl Grey… decaf.")
$json.UpdateBool("queue_if_low_balance",$true)
$json.UpdateString("reference_id","Acme Transaction ID 12345")
$json.UpdateString("narration","Acme Corp Fund Transfer")
$json.UpdateString("notes.notes_key_1","Beam me up Scotty")
$json.UpdateString("notes.notes_key_2","Engage")

$http.SetRequestHeader("X-Payout-Idempotency","")

$resp = $http.PostJson3("https://api.razorpay.com/v1/payouts","application/json",$json)
if ($http.LastMethodSuccess -eq $false) {
    $($http.LastErrorText)
    exit
}

$($resp.StatusCode)
$($resp.BodyStr)

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