Chilkat Online Tools

Ruby / Razorpay APIs / Rename Labels in Payment Details Section

Back to Collection Items

require 'chilkat'

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

http = Chilkat::CkHttp.new()

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.

# {
#   "amount": 1000,
#   "currency": "INR",
#   "accept_partial": true,
#   "first_min_partial_amount": 100,
#   "reference_id": "#412232",
#   "description": "Payment for policy no #23456",
#   "expire_by": 1599193801,
#   "customer": {
#     "name": "Gaurav Kumar",
#     "contact": "+919999999999",
#     "email": "gaurav.kumar@example.com"
#   },
#   "notify": {
#     "sms": true,
#     "email": true
#   },
#   "reminder_enable": true,
#   "options": {
#     "hosted_page": {
#       "label": {
#         "receipt": "Ref No.",
#         "description": "Course Name",
#         "amount_payable": "Course Fee Payable",
#         "amount_paid": "Course Fee Paid",
#         "partial_amount_due": "Fee Installment Due",
#         "partial_amount_paid": "Fee Installment Paid",
#         "expire_by": "Pay Before",
#         "expired_on": "Link Expired. Please contact Admin",
#         "amount_due": "Course Fee Due"
#       },
#       "show_preferences": {
#         "issued_to": false
#       }
#     }
#   }
# }

json = Chilkat::CkJsonObject.new()
json.UpdateInt("amount",1000)
json.UpdateString("currency","INR")
json.UpdateBool("accept_partial",true)
json.UpdateInt("first_min_partial_amount",100)
json.UpdateString("reference_id","#412232")
json.UpdateString("description","Payment for policy no #23456")
json.UpdateInt("expire_by",1599193801)
json.UpdateString("customer.name","Gaurav Kumar")
json.UpdateString("customer.contact","+919999999999")
json.UpdateString("customer.email","gaurav.kumar@example.com")
json.UpdateBool("notify.sms",true)
json.UpdateBool("notify.email",true)
json.UpdateBool("reminder_enable",true)
json.UpdateString("options.hosted_page.label.receipt","Ref No.")
json.UpdateString("options.hosted_page.label.description","Course Name")
json.UpdateString("options.hosted_page.label.amount_payable","Course Fee Payable")
json.UpdateString("options.hosted_page.label.amount_paid","Course Fee Paid")
json.UpdateString("options.hosted_page.label.partial_amount_due","Fee Installment Due")
json.UpdateString("options.hosted_page.label.partial_amount_paid","Fee Installment Paid")
json.UpdateString("options.hosted_page.label.expire_by","Pay Before")
json.UpdateString("options.hosted_page.label.expired_on","Link Expired. Please contact Admin")
json.UpdateString("options.hosted_page.label.amount_due","Course Fee Due")
json.UpdateBool("options.hosted_page.show_preferences.issued_to",false)

# resp is a CkHttpResponse
resp = http.PostJson3("https://api.razorpay.com/v1/payment_links/","application/json",json)
if (http.get_LastMethodSuccess() == false)
    print http.lastErrorText() + "\n";
    exit
end

print resp.get_StatusCode().to_s() + "\n";
print resp.bodyStr() + "\n";

Curl Command

curl -X POST
	-u 'username:password'
	-d '{
  "amount": 1000,
  "currency": "INR",
  "accept_partial": true,
  "first_min_partial_amount": 100,
  "reference_id": "#412232",
  "description": "Payment for policy no #23456",
  "expire_by": 1599193801,
  "customer": {
    "name": "Gaurav Kumar",
    "contact": "+919999999999",
    "email": "gaurav.kumar@example.com"
  },
  "notify": {
    "sms": true,
    "email": true
  },
  "reminder_enable": true,
  "options": {
    "hosted_page": {
      "label": {
        "receipt": "Ref No.",
        "description": "Course Name",
        "amount_payable": "Course Fee Payable",
        "amount_paid": "Course Fee Paid",
        "partial_amount_due": "Fee Installment Due",
        "partial_amount_paid": "Fee Installment Paid",
        "expire_by": "Pay Before",
        "expired_on": "Link Expired. Please contact Admin",
        "amount_due": "Course Fee Due"
      },
      "show_preferences": {
        "issued_to": false
      }
    }
  }
}'
https://api.razorpay.com/v1/payment_links/

Postman Collection Item JSON

{
  "name": "Rename Labels in Payment Details Section",
  "request": {
    "method": "POST",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"amount\": 1000,\n  \"currency\": \"INR\",\n  \"accept_partial\": true,\n  \"first_min_partial_amount\": 100,\n  \"reference_id\": \"#412232\",\n  \"description\": \"Payment for policy no #23456\",\n  \"expire_by\": 1599193801,\n  \"customer\": {\n    \"name\": \"Gaurav Kumar\",\n    \"contact\": \"+919999999999\",\n    \"email\": \"gaurav.kumar@example.com\"\n  },\n  \"notify\": {\n    \"sms\": true,\n    \"email\": true\n  },\n  \"reminder_enable\": true,\n  \"options\": {\n    \"hosted_page\": {\n      \"label\": {\n        \"receipt\": \"Ref No.\",\n        \"description\": \"Course Name\",\n        \"amount_payable\": \"Course Fee Payable\",\n        \"amount_paid\": \"Course Fee Paid\",\n        \"partial_amount_due\": \"Fee Installment Due\",\n        \"partial_amount_paid\": \"Fee Installment Paid\",\n        \"expire_by\": \"Pay Before\",\n        \"expired_on\": \"Link Expired. Please contact Admin\",\n        \"amount_due\": \"Course Fee Due\"\n      },\n      \"show_preferences\": {\n        \"issued_to\": false\n      }\n    }\n  }\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "https://api.razorpay.com/v1/payment_links/",
      "protocol": "https",
      "host": [
        "api",
        "razorpay",
        "com"
      ],
      "path": [
        "v1",
        "payment_links",
        ""
      ]
    },
    "description": "Learn how to customize and rename the labels in the Payment Details section of the Payment Links payment request page using Razorpay API. You can also display labels in a different language, for example, Hindi or Tamil."
  },
  "response": [
  ]
}