Chilkat Online Tools

PureBasic / Razorpay APIs / Offers on Payment Links

Back to Collection Items

IncludeFile "CkJsonObject.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"

Procedure ChilkatExample()

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

    http.i = CkHttp::ckCreate()
    If http.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success.i

    CkHttp::setCkBasicAuth(http, 1)
    CkHttp::setCkLogin(http, "username")
    CkHttp::setCkPassword(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"
    ;       ]
    ;     }
    ;   }
    ; }

    json.i = CkJsonObject::ckCreate()
    If json.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckUpdateInt(json,"amount",3400)
    CkJsonObject::ckUpdateString(json,"currency","INR")
    CkJsonObject::ckUpdateBool(json,"accept_partial",0)
    CkJsonObject::ckUpdateString(json,"reference_id","#425")
    CkJsonObject::ckUpdateString(json,"description","Payment for policy no #23456")
    CkJsonObject::ckUpdateString(json,"customer.name","Gaurav Kumar")
    CkJsonObject::ckUpdateString(json,"customer.contact","+919999999999")
    CkJsonObject::ckUpdateString(json,"customer.email","gaurav.kumar@example.com")
    CkJsonObject::ckUpdateBool(json,"notify.sms",1)
    CkJsonObject::ckUpdateBool(json,"notify.email",1)
    CkJsonObject::ckUpdateBool(json,"reminder_enable",0)
    CkJsonObject::ckUpdateString(json,"options.order.offers[0]","offer_F4WMTC3pwFKnzq")
    CkJsonObject::ckUpdateString(json,"options.order.offers[1]","offer_F4WJHqvGzw8dWF")

    resp.i = CkHttpResponse::ckCreate()
    If resp.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success = CkHttp::ckHttpJson(http,"POST","https://api.razorpay.com/v1/payment_links",json,"application/json",resp)
    If success = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(json)
        CkHttpResponse::ckDispose(resp)
        ProcedureReturn
    EndIf

    Debug Str(CkHttpResponse::ckStatusCode(resp))
    Debug CkHttpResponse::ckBodyStr(resp)


    CkHttp::ckDispose(http)
    CkJsonObject::ckDispose(json)
    CkHttpResponse::ckDispose(resp)


    ProcedureReturn
EndProcedure

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": [
  ]
}