Chilkat Online Tools

PureBasic / Razorpay APIs / Hold Settlements For Transfers

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.

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

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

    CkJsonObject::ckUpdateInt(json,"transfers[0].amount",100)
    CkJsonObject::ckUpdateString(json,"transfers[0].account","acc_id")
    CkJsonObject::ckUpdateString(json,"transfers[0].currency","INR")
    CkJsonObject::ckUpdateInt(json,"transfers[0].on_hold",1)

    CkHttp::ckSetRequestHeader(http,"content-type","application/json")

    resp.i = CkHttp::ckPostJson3(http,"https://api.razorpay.com/v1/payments/{pay_id}/transfers","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 '{
    "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": [
  ]
}