Chilkat Online Tools

Node.js / Razorpay APIs / Hold Settlements For Transfers

Back to Collection Items

var os = require('os');
if (os.platform() == 'win32') {  
    if (os.arch() == 'ia32') {
        var chilkat = require('@chilkat/ck-node21-win-ia32');
    } else {
        var chilkat = require('@chilkat/ck-node21-win64'); 
    }
} else if (os.platform() == 'linux') {
    if (os.arch() == 'arm') {
        var chilkat = require('@chilkat/ck-node21-arm');
    } else if (os.arch() == 'x86') {
        var chilkat = require('@chilkat/ck-node21-linux32');
    } else {
        var chilkat = require('@chilkat/ck-node21-linux64');
    }
} else if (os.platform() == 'darwin') {
    if (os.arch() == 'arm64') {
        var chilkat = require('@chilkat/ck-node21-mac-m1');
    } else {
        var chilkat = require('@chilkat/ck-node21-macosx');
    }
}


function chilkatExample() {

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

    var http = new chilkat.Http();
    var success;

    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.

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

    var json = new chilkat.JsonObject();
    json.UpdateInt("transfers[0].amount",100);
    json.UpdateString("transfers[0].account","acc_id");
    json.UpdateString("transfers[0].currency","INR");
    json.UpdateInt("transfers[0].on_hold",1);

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

    // resp: HttpResponse
    var resp = http.PostJson3("https://api.razorpay.com/v1/payments/{pay_id}/transfers","application/json",json);
    if (http.LastMethodSuccess == false) {
        console.log(http.LastErrorText);
        return;
    }

    console.log(resp.StatusCode);
    console.log(resp.BodyStr);


}

chilkatExample();

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