Chilkat Online Tools

Ruby / Razorpay APIs / Modify Transfer Settlement Hold

Back to Collection Items

require 'chilkat'

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

http = Chilkat::CkHttp.new()

http.put_BasicAuth(true)
http.put_Login("username")
http.put_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.

# {
#   "on_hold": 1,
#   "on_hold_until": 1979691505
# }

json = Chilkat::CkJsonObject.new()
json.UpdateInt("on_hold",1)
json.UpdateInt("on_hold_until",1979691505)

http.SetRequestHeader("content-type","application/json")

sbRequestBody = Chilkat::CkStringBuilder.new()
json.EmitSb(sbRequestBody)

# resp is a CkHttpResponse
resp = http.PTextSb("PATCH","https://api.razorpay.com/v1/transfers/{trf_id}",sbRequestBody,"utf-8","application/json",false,false)
if (http.get_LastMethodSuccess() == false)
    print http.lastErrorText() + "\n";
    exit
end

print resp.get_StatusCode().to_s() + "\n";
print resp.bodyStr() + "\n";

Curl Command

curl -X PATCH
	-u 'username:password'
	-H "content-type: application/json"
	-d '{
    "on_hold": 1,
    "on_hold_until": 1979691505
}'
https://api.razorpay.com/v1/transfers/{trf_id}

Postman Collection Item JSON

{
  "name": "Modify Transfer Settlement Hold",
  "request": {
    "method": "PATCH",
    "header": [
      {
        "key": "content-type",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"on_hold\": 1,\n    \"on_hold_until\": 1979691505\n}"
    },
    "url": {
      "raw": "https://api.razorpay.com/v1/transfers/{trf_id}",
      "protocol": "https",
      "host": [
        "api",
        "razorpay",
        "com"
      ],
      "path": [
        "v1",
        "transfers",
        "{trf_id}"
      ]
    },
    "description": "Use this [API](https://razorpay.com/docs/api/route/#modify-settlement-hold-for-transfers) to modify the settlement configuration for a particular `transfer_id`. On a successful request, the API responds with the modified transfer entity."
  },
  "response": [
  ]
}