Chilkat Online Tools

phpAx / Razorpay APIs / Create On-Demand Settlement

Back to Collection Items

<?php

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

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.Http')
$http = new COM("Chilkat.Http");

$http->BasicAuth = 1;
$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.

// {
//   "amount": 50000,
//   "max_balance": 0,
//   "description": "Need this to make vendor payouts",
//   "notes": {
//     "notes_key_1": "Tea, Earl Grey, Hot",
//     "notes_key_2": "Tea, Earl Grey… decaf."
//   }
// }

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonObject')
$json = new COM("Chilkat.JsonObject");
$json->UpdateInt('amount',50000);
$json->UpdateInt('max_balance',0);
$json->UpdateString('description','Need this to make vendor payouts');
$json->UpdateString('notes.notes_key_1','Tea, Earl Grey, Hot');
$json->UpdateString('notes.notes_key_2','Tea, Earl Grey… decaf.');

$http->SetRequestHeader('Content-Type','application/json');

// resp is a Chilkat.HttpResponse
$resp = $http->PostJson3('https://api.razorpay.com/v1/settlements/ondemand','application/json',$json);
if ($http->LastMethodSuccess == 0) {
    print $http->LastErrorText . "\n";
    exit;
}

print $resp->StatusCode . "\n";
print $resp->BodyStr . "\n";


?>

Curl Command

curl -X POST
	-u 'username:password'
	-H "Content-Type: application/json"
	-d '{
  "amount": 50000,
  "max_balance": 0,
  "description": "Need this to make vendor payouts",
  "notes": {
    "notes_key_1": "Tea, Earl Grey, Hot",
    "notes_key_2": "Tea, Earl Grey… decaf."
  }
}'
https://api.razorpay.com/v1/settlements/ondemand

Postman Collection Item JSON

{
  "name": "Create On-Demand Settlement",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Content-Type",
        "type": "text",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"amount\": 50000,\n  \"max_balance\": 0,\n  \"description\": \"Need this to make vendor payouts\",\n  \"notes\": {\n    \"notes_key_1\": \"Tea, Earl Grey, Hot\",\n    \"notes_key_2\": \"Tea, Earl Grey… decaf.\"\n  }\n}"
    },
    "url": {
      "raw": "https://api.razorpay.com/v1/settlements/ondemand",
      "protocol": "https",
      "host": [
        "api",
        "razorpay",
        "com"
      ],
      "path": [
        "v1",
        "settlements",
        "ondemand"
      ]
    },
    "description": "Create an on-demand settlement using this API. Here, `amount` is a mandatory parameter.\n\nKnow more about the <a href=\"https://razorpay.com/docs/api/settlements/#create-an-on-demand-settlement\" target=\"_blank\">Create an On-demand Settlement API</a>."
  },
  "response": [
  ]
}