Chilkat Online Tools

phpExt / Razorpay APIs / Composite API - Bank Account

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.

// {
//   "account_number": "account_number",
//   "amount": 100,
//   "currency": "INR",
//   "mode": "NEFT",
//   "purpose": "refund",
//   "fund_account": {
//     "account_type": "bank_account",
//     "bank_account": {
//       "name": "Gaurav Kumar",
//       "ifsc": "HDFC0001234",
//       "account_number": "1121431121541121"
//     },
//     "contact": {
//       "name": "Gaurav Kumar",
//       "email": "gaurav.kumar@example.com",
//       "contact": "9876543210",
//       "type": "employee",
//       "reference_id": "Acme Contact ID 12345",
//       "notes": {
//         "notes_key_1": "Tea, Earl Grey, Hot",
//         "notes_key_2": "Tea, Earl Grey… decaf."
//       }
//     }
//   },
//   "queue_if_low_balance": true,
//   "reference_id": "Acme Transaction ID 12345",
//   "narration": "Acme Corp Fund Transfer",
//   "notes": {
//     "notes_key_1": "Beam me up Scotty",
//     "notes_key_2": "Engage"
//   }
// }

$json = new CkJsonObject();
$json->UpdateString('account_number','account_number');
$json->UpdateInt('amount',100);
$json->UpdateString('currency','INR');
$json->UpdateString('mode','NEFT');
$json->UpdateString('purpose','refund');
$json->UpdateString('fund_account.account_type','bank_account');
$json->UpdateString('fund_account.bank_account.name','Gaurav Kumar');
$json->UpdateString('fund_account.bank_account.ifsc','HDFC0001234');
$json->UpdateString('fund_account.bank_account.account_number','1121431121541121');
$json->UpdateString('fund_account.contact.name','Gaurav Kumar');
$json->UpdateString('fund_account.contact.email','gaurav.kumar@example.com');
$json->UpdateString('fund_account.contact.contact','9876543210');
$json->UpdateString('fund_account.contact.type','employee');
$json->UpdateString('fund_account.contact.reference_id','Acme Contact ID 12345');
$json->UpdateString('fund_account.contact.notes.notes_key_1','Tea, Earl Grey, Hot');
$json->UpdateString('fund_account.contact.notes.notes_key_2','Tea, Earl Grey… decaf.');
$json->UpdateBool('queue_if_low_balance',true);
$json->UpdateString('reference_id','Acme Transaction ID 12345');
$json->UpdateString('narration','Acme Corp Fund Transfer');
$json->UpdateString('notes.notes_key_1','Beam me up Scotty');
$json->UpdateString('notes.notes_key_2','Engage');

$http->SetRequestHeader('X-Payout-Idempotency','');

// resp is a CkHttpResponse
$resp = $http->PostJson3('https://api.razorpay.com/v1/payouts','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 "X-Payout-Idempotency: "
	-d '{
    "account_number":"account_number",
    "amount":100,
    "currency":"INR",
    "mode":"NEFT",
    "purpose":"refund",
    "fund_account":{
        "account_type":"bank_account",
        "bank_account":{
            "name":"Gaurav Kumar",
            "ifsc":"HDFC0001234",
            "account_number":"1121431121541121"
        },
        "contact":{
            "name":"Gaurav Kumar",
            "email":"gaurav.kumar@example.com",
            "contact":"9876543210",
            "type":"employee",
            "reference_id":"Acme Contact ID 12345",
            "notes":{
                "notes_key_1":"Tea, Earl Grey, Hot",
                "notes_key_2":"Tea, Earl Grey… decaf."
            }
        }
    },
    "queue_if_low_balance":true,
    "reference_id":"Acme Transaction ID 12345",
    "narration":"Acme Corp Fund Transfer",
    "notes":{
        "notes_key_1":"Beam me up Scotty",
        "notes_key_2":"Engage"
    }
}'
https://api.razorpay.com/v1/payouts

Postman Collection Item JSON

{
  "name": "Composite API - Bank Account",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "X-Payout-Idempotency",
        "value": "",
        "type": "text"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"account_number\":\"account_number\",\n    \"amount\":100,\n    \"currency\":\"INR\",\n    \"mode\":\"NEFT\",\n    \"purpose\":\"refund\",\n    \"fund_account\":{\n        \"account_type\":\"bank_account\",\n        \"bank_account\":{\n            \"name\":\"Gaurav Kumar\",\n            \"ifsc\":\"HDFC0001234\",\n            \"account_number\":\"1121431121541121\"\n        },\n        \"contact\":{\n            \"name\":\"Gaurav Kumar\",\n            \"email\":\"gaurav.kumar@example.com\",\n            \"contact\":\"9876543210\",\n            \"type\":\"employee\",\n            \"reference_id\":\"Acme Contact ID 12345\",\n            \"notes\":{\n                \"notes_key_1\":\"Tea, Earl Grey, Hot\",\n                \"notes_key_2\":\"Tea, Earl Grey… decaf.\"\n            }\n        }\n    },\n    \"queue_if_low_balance\":true,\n    \"reference_id\":\"Acme Transaction ID 12345\",\n    \"narration\":\"Acme Corp Fund Transfer\",\n    \"notes\":{\n        \"notes_key_1\":\"Beam me up Scotty\",\n        \"notes_key_2\":\"Engage\"\n    }\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "https://api.razorpay.com/v1/payouts",
      "protocol": "https",
      "host": [
        "api",
        "razorpay",
        "com"
      ],
      "path": [
        "v1",
        "payouts"
      ]
    },
    "description": "Use this [API](https://razorpay.com/docs/api/razorpayx/composite-api/#bank-account) to create a payout using contact and bank account details."
  },
  "response": [
  ]
}