Chilkat Online Tools

TCL / Razorpay APIs / Offers on Payment Links

Back to Collection Items

load ./chilkat.dll

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

set http [new_CkHttp]

CkHttp_put_BasicAuth $http 1
CkHttp_put_Login $http "username"
CkHttp_put_Password $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.

# {
#   "amount": 3400,
#   "currency": "INR",
#   "accept_partial": false,
#   "reference_id": "#425",
#   "description": "Payment for policy no #23456",
#   "customer": {
#     "name": "Gaurav Kumar",
#     "contact": "+919999999999",
#     "email": "gaurav.kumar@example.com"
#   },
#   "notify": {
#     "sms": true,
#     "email": true
#   },
#   "reminder_enable": false,
#   "options": {
#     "order": {
#       "offers": [
#         "offer_F4WMTC3pwFKnzq",
#         "offer_F4WJHqvGzw8dWF"
#       ]
#     }
#   }
# }

set json [new_CkJsonObject]

CkJsonObject_UpdateInt $json "amount" 3400
CkJsonObject_UpdateString $json "currency" "INR"
CkJsonObject_UpdateBool $json "accept_partial" 0
CkJsonObject_UpdateString $json "reference_id" "#425"
CkJsonObject_UpdateString $json "description" "Payment for policy no #23456"
CkJsonObject_UpdateString $json "customer.name" "Gaurav Kumar"
CkJsonObject_UpdateString $json "customer.contact" "+919999999999"
CkJsonObject_UpdateString $json "customer.email" "gaurav.kumar@example.com"
CkJsonObject_UpdateBool $json "notify.sms" 1
CkJsonObject_UpdateBool $json "notify.email" 1
CkJsonObject_UpdateBool $json "reminder_enable" 0
CkJsonObject_UpdateString $json "options.order.offers[0]" "offer_F4WMTC3pwFKnzq"
CkJsonObject_UpdateString $json "options.order.offers[1]" "offer_F4WJHqvGzw8dWF"

# resp is a CkHttpResponse
set resp [CkHttp_PostJson3 $http "https://api.razorpay.com/v1/payment_links" "application/json" $json]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkJsonObject $json
    exit
}

puts [CkHttpResponse_get_StatusCode $resp]
puts [CkHttpResponse_bodyStr $resp]
delete_CkHttpResponse $resp


delete_CkHttp $http
delete_CkJsonObject $json

Curl Command

curl -X POST
	-u 'username:password'
	-d '{
  "amount": 3400,
  "currency": "INR",
  "accept_partial": false,
  "reference_id": "#425",
  "description": "Payment for policy no #23456",
  "customer": {
    "name": "Gaurav Kumar",
    "contact": "+919999999999",
    "email": "gaurav.kumar@example.com"
  },
  "notify": {
    "sms": true,
    "email": true
  },
  "reminder_enable": false,
  "options": {
    "order": {
      "offers": [
        "offer_F4WMTC3pwFKnzq",
        "offer_F4WJHqvGzw8dWF"
      ]
    }
  }
}'
https://api.razorpay.com/v1/payment_links

Postman Collection Item JSON

{
  "name": "Offers on Payment Links",
  "request": {
    "method": "POST",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"amount\": 3400,\n  \"currency\": \"INR\",\n  \"accept_partial\": false,\n  \"reference_id\": \"#425\",\n  \"description\": \"Payment for policy no #23456\",\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\": false,\n  \"options\": {\n    \"order\": {\n      \"offers\": [\n        \"offer_F4WMTC3pwFKnzq\",\n        \"offer_F4WJHqvGzw8dWF\"\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": "Using Razorpay Offers, you can provide discounts or cashback on Payment Links issued to customers. You can restrict the payment methods on which the Offers are applied and limit their usage to a defined time period.\n\nKnow more about this <a href=\"https://razorpay.com/docs/api/payment-links/advanced-options/offers/\" target=\"_blank\">API</a>."
  },
  "response": [
  ]
}