Chilkat Online Tools

TCL / Razorpay APIs / Hold Settlements For Transfers

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.

# {
#   "transfers": [
#     {
#       "amount": 100,
#       "account": "acc_id",
#       "currency": "INR",
#       "on_hold": 1
#     }
#   ]
# }

set json [new_CkJsonObject]

CkJsonObject_UpdateInt $json "transfers[0].amount" 100
CkJsonObject_UpdateString $json "transfers[0].account" "acc_id"
CkJsonObject_UpdateString $json "transfers[0].currency" "INR"
CkJsonObject_UpdateInt $json "transfers[0].on_hold" 1

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

# resp is a CkHttpResponse
set resp [CkHttp_PostJson3 $http "https://api.razorpay.com/v1/payments/{pay_id}/transfers" "application/json" $json]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkJsonObject $json
    exit
}

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


delete_CkHttp $http
delete_CkJsonObject $json

Curl Command

curl -X POST
	-u 'username:password'
	-H "content-type: application/json"
	-d '{
    "transfers": [
        {
            "amount": 100,
            "account": "acc_id",//Please replace with appropriate ID.
            "currency": "INR",
            "on_hold": 1
        }
    ]
}'
https://api.razorpay.com/v1/payments/{pay_id}/transfers

Postman Collection Item JSON

{
  "name": "Hold Settlements For Transfers",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "content-type",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"transfers\": [\n        {\n            \"amount\": 100,\n            \"account\": \"acc_id\",//Please replace with appropriate ID.\n            \"currency\": \"INR\",\n            \"on_hold\": 1\n        }\n    ]\n}"
    },
    "url": {
      "raw": "https://api.razorpay.com/v1/payments/{pay_id}/transfers",
      "protocol": "https",
      "host": [
        "api",
        "razorpay",
        "com"
      ],
      "path": [
        "v1",
        "payments",
        "{pay_id}",
        "transfers"
      ]
    },
    "description": "When transferring payment to an account, you can choose to put the transfer settlement on hold indefinitely or until a defined time. You can change these settings anytime via this [API](https://razorpay.com/docs/api/route/#hold-settlements-for-transfers) until the settlement is made. When you put a transfer settlement on hold, the settlement will not happen until you release it."
  },
  "response": [
  ]
}