Chilkat Online Tools

TCL / Razorpay APIs / Modify Transfer Settlement Hold

Back to Collection Items

load ./chilkat.dll

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

set http [new_CkHttp]

CkHttp_put_BasicAuth $http 1
CkHttp_put_Login $http "username"
CkHttp_put_Password $http "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
# }

set json [new_CkJsonObject]

CkJsonObject_UpdateInt $json "on_hold" 1
CkJsonObject_UpdateInt $json "on_hold_until" 1979691505

CkHttp_SetRequestHeader $http "content-type" "application/json"

set sbRequestBody [new_CkStringBuilder]

CkJsonObject_EmitSb $json $sbRequestBody

# resp is a CkHttpResponse
set resp [CkHttp_PTextSb $http "PATCH" "https://api.razorpay.com/v1/transfers/{trf_id}" $sbRequestBody "utf-8" "application/json" 0 0]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkJsonObject $json
    delete_CkStringBuilder $sbRequestBody
    exit
}

puts [CkHttpResponse_get_StatusCode $resp]
puts [CkHttpResponse_bodyStr $resp]
delete_CkHttpResponse $resp


delete_CkHttp $http
delete_CkJsonObject $json
delete_CkStringBuilder $sbRequestBody

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