Chilkat Online Tools

delphiDll / Razorpay APIs / Composite API - VPA

Back to Collection Items

var
http: HCkHttp;
success: Boolean;
json: HCkJsonObject;
resp: HCkHttpResponse;

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

http := CkHttp_Create();

CkHttp_putBasicAuth(http,True);
CkHttp_putLogin(http,'username');
CkHttp_putPassword(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.

// {
//   "account_number": "account_number",
//   "amount": 10000,
//   "currency": "INR",
//   "mode": "UPI",
//   "purpose": "refund",
//   "fund_account": {
//     "account_type": "vpa",
//     "vpa": {
//       "address": "gauravkumar@exampleupi"
//     },
//     "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 := CkJsonObject_Create();
CkJsonObject_UpdateString(json,'account_number','account_number');
CkJsonObject_UpdateInt(json,'amount',10000);
CkJsonObject_UpdateString(json,'currency','INR');
CkJsonObject_UpdateString(json,'mode','UPI');
CkJsonObject_UpdateString(json,'purpose','refund');
CkJsonObject_UpdateString(json,'fund_account.account_type','vpa');
CkJsonObject_UpdateString(json,'fund_account.vpa.address','gauravkumar@exampleupi');
CkJsonObject_UpdateString(json,'fund_account.contact.name','Gaurav Kumar');
CkJsonObject_UpdateString(json,'fund_account.contact.email','gaurav.kumar@example.com');
CkJsonObject_UpdateString(json,'fund_account.contact.contact','9876543210');
CkJsonObject_UpdateString(json,'fund_account.contact.type','employee');
CkJsonObject_UpdateString(json,'fund_account.contact.reference_id','Acme Contact ID 12345');
CkJsonObject_UpdateString(json,'fund_account.contact.notes.notes_key_1','Tea, Earl Grey, Hot');
CkJsonObject_UpdateString(json,'fund_account.contact.notes.notes_key_2','Tea, Earl Grey… decaf.');
CkJsonObject_UpdateBool(json,'queue_if_low_balance',True);
CkJsonObject_UpdateString(json,'reference_id','Acme Transaction ID 12345');
CkJsonObject_UpdateString(json,'narration','Acme Corp Fund Transfer');
CkJsonObject_UpdateString(json,'notes.notes_key_1','Beam me up Scotty');
CkJsonObject_UpdateString(json,'notes.notes_key_2','Engage');

CkHttp_SetRequestHeader(http,'X-Payout-Idempotency','');

resp := CkHttp_PostJson3(http,'https://api.razorpay.com/v1/payouts','application/json',json);
if (CkHttp_getLastMethodSuccess(http) = False) then
  begin
    Memo1.Lines.Add(CkHttp__lastErrorText(http));
    Exit;
  end;

Memo1.Lines.Add(IntToStr(CkHttpResponse_getStatusCode(resp)));
Memo1.Lines.Add(CkHttpResponse__bodyStr(resp));
CkHttpResponse_Dispose(resp);

CkHttp_Dispose(http);
CkJsonObject_Dispose(json);

Curl Command

curl -X POST
	-u 'username:password'
	-H "X-Payout-Idempotency: "
	-d '{
    "account_number":"account_number",
    "amount":10000,
    "currency":"INR",
    "mode":"UPI",
    "purpose":"refund",
    "fund_account":{
        "account_type":"vpa",
        "vpa":{
            "address":"gauravkumar@exampleupi"
        },
        "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 - VPA",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "X-Payout-Idempotency",
        "value": "",
        "type": "text"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"account_number\":\"account_number\",\n    \"amount\":10000,\n    \"currency\":\"INR\",\n    \"mode\":\"UPI\",\n    \"purpose\":\"refund\",\n    \"fund_account\":{\n        \"account_type\":\"vpa\",\n        \"vpa\":{\n            \"address\":\"gauravkumar@exampleupi\"\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/#vpa-upi-id) to create a payout using contact and VPA."
  },
  "response": [
  ]
}