Chilkat Online Tools

PureBasic / Razorpay APIs / Create On-Demand Settlement

Back to Collection Items

IncludeFile "CkJsonObject.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"

Procedure ChilkatExample()

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

    http.i = CkHttp::ckCreate()
    If http.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success.i

    CkHttp::setCkBasicAuth(http, 1)
    CkHttp::setCkLogin(http, "username")
    CkHttp::setCkPassword(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.

    ; {
    ;   "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."
    ;   }
    ; }

    json.i = CkJsonObject::ckCreate()
    If json.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckUpdateInt(json,"amount",50000)
    CkJsonObject::ckUpdateInt(json,"max_balance",0)
    CkJsonObject::ckUpdateString(json,"description","Need this to make vendor payouts")
    CkJsonObject::ckUpdateString(json,"notes.notes_key_1","Tea, Earl Grey, Hot")
    CkJsonObject::ckUpdateString(json,"notes.notes_key_2","Tea, Earl Grey… decaf.")

    CkHttp::ckSetRequestHeader(http,"Content-Type","application/json")

    resp.i = CkHttp::ckPostJson3(http,"https://api.razorpay.com/v1/settlements/ondemand","application/json",json)
    If CkHttp::ckLastMethodSuccess(http) = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(json)
        ProcedureReturn
    EndIf

    Debug Str(CkHttpResponse::ckStatusCode(resp))
    Debug CkHttpResponse::ckBodyStr(resp)
    CkHttpResponse::ckDispose(resp)



    CkHttp::ckDispose(http)
    CkJsonObject::ckDispose(json)


    ProcedureReturn
EndProcedure

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