Chilkat Online Tools

phpExt / Razorpay APIs / Transfer via Payments

Back to Collection Items

<?php

include("chilkat_9_5_0.php");

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

$http = new CkHttp();

$http->put_BasicAuth(true);
$http->put_Login('username');
$http->put_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": [
//     {
//       "account": "acc_id",
//       "amount": 100,
//       "currency": "INR",
//       "notes": {
//         "name": "Gaurav Kumar",
//         "roll_no": "IEC2011025"
//       },
//       "linked_account_notes": [
//         "roll_no"
//       ],
//       "on_hold": true,
//       "on_hold_until": 1671222870
//     },
//     {
//       "account": "acc_id",
//       "amount": 100,
//       "currency": "INR",
//       "notes": {
//         "name": "Saurav Kumar",
//         "roll_no": "IEC2011026"
//       },
//       "linked_account_notes": [
//         "roll_no"
//       ],
//       "on_hold": false
//     }
//   ]
// }

$json = new CkJsonObject();
$json->UpdateString('transfers[0].account','acc_id');
$json->UpdateInt('transfers[0].amount',100);
$json->UpdateString('transfers[0].currency','INR');
$json->UpdateString('transfers[0].notes.name','Gaurav Kumar');
$json->UpdateString('transfers[0].notes.roll_no','IEC2011025');
$json->UpdateString('transfers[0].linked_account_notes[0]','roll_no');
$json->UpdateBool('transfers[0].on_hold',true);
$json->UpdateInt('transfers[0].on_hold_until',1671222870);
$json->UpdateString('transfers[1].account','acc_id');
$json->UpdateInt('transfers[1].amount',100);
$json->UpdateString('transfers[1].currency','INR');
$json->UpdateString('transfers[1].notes.name','Saurav Kumar');
$json->UpdateString('transfers[1].notes.roll_no','IEC2011026');
$json->UpdateString('transfers[1].linked_account_notes[0]','roll_no');
$json->UpdateBool('transfers[1].on_hold',false);

$http->SetRequestHeader('content-type','application/json');

// resp is a CkHttpResponse
$resp = $http->PostJson3('https://api.razorpay.com/v1/payments/{pay_id}/transfers','application/json',$json);
if ($http->get_LastMethodSuccess() == false) {
    print $http->lastErrorText() . "\n";
    exit;
}

print $resp->get_StatusCode() . "\n";
print $resp->bodyStr() . "\n";


?>

Curl Command

curl -X POST
	-u 'username:password'
	-H "content-type: application/json"
	-d '{
    "transfers": [
        {
            "account": "acc_id",//Please replace with appropriate ID.
            "amount": 100,
            "currency": "INR",
            "notes": {
                "name": "Gaurav Kumar",
                "roll_no": "IEC2011025"
            },
            "linked_account_notes": [
                "roll_no"
            ],
            "on_hold": true,
            "on_hold_until": 1671222870
        },
        {
            "account": "acc_id",//Please replace with appropriate ID.
            "amount": 100,
            "currency": "INR",
            "notes": {
                "name": "Saurav Kumar",
                "roll_no": "IEC2011026"
            },
            "linked_account_notes": [
                "roll_no"
            ],
            "on_hold": false
        }
    ]
}'
https://api.razorpay.com/v1/payments/{pay_id}/transfers

Postman Collection Item JSON

{
  "name": "Transfer via Payments",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "content-type",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"transfers\": [\n        {\n            \"account\": \"acc_id\",//Please replace with appropriate ID.\n            \"amount\": 100,\n            \"currency\": \"INR\",\n            \"notes\": {\n                \"name\": \"Gaurav Kumar\",\n                \"roll_no\": \"IEC2011025\"\n            },\n            \"linked_account_notes\": [\n                \"roll_no\"\n            ],\n            \"on_hold\": true,\n            \"on_hold_until\": 1671222870\n        },\n        {\n            \"account\": \"acc_id\",//Please replace with appropriate ID.\n            \"amount\": 100,\n            \"currency\": \"INR\",\n            \"notes\": {\n                \"name\": \"Saurav Kumar\",\n                \"roll_no\": \"IEC2011026\"\n            },\n            \"linked_account_notes\": [\n                \"roll_no\"\n            ],\n            \"on_hold\": false\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": "You can use this [API](https://razorpay.com/docs/api/route/#create-transfers-from-payments) to transfer a `captured` payment to one or more linked accounts using `account_id`. A response will be generated on a successful transfer with a collection of transfer entities created for the payment."
  },
  "response": [
  ]
}