Chilkat Online Tools

Swift3 / Razorpay APIs / Update an Invoice

Back to Collection Items

func chilkatTest() {
    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    let http = CkoHttp()!
    var success: Bool

    http.basicAuth = true
    http.login = "username"
    http.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.

    // {
    //   "partial_payment": true,
    //   "customer": {
    //     "name": "Saurav Kumar",
    //     "contact": "9123456789",
    //     "email": "saurav.kumar@example.com"
    //   },
    //   "line_items": [
    //     {
    //       "name": "Crate of Red Herbs",
    //       "description": "Red Herbs from Resident Evil",
    //       "amount": 50000,
    //       "currency": "INR",
    //       "quantity": 5
    //     },
    //     {
    //       "item_id": "{item_id}"
    //     }
    //   ],
    //   "sms_notify": 1,
    //   "email_notify": 1,
    //   "draft": "1",
    //   "date": 1588076279,
    //   "expire_by": 1924991999,
    //   "receipt": "Receipt No. 1",
    //   "comment": "Fresh herbs mowed this morning",
    //   "terms": "No Returns; No Refunds",
    //   "notes": {
    //     "notes_key_1": "Beam me up Scotty.",
    //     "notes_key_2": "Engage"
    //   }
    // }

    let json = CkoJsonObject()!
    json.updateBool("partial_payment", value: true)
    json.update("customer.name", value: "Saurav Kumar")
    json.update("customer.contact", value: "9123456789")
    json.update("customer.email", value: "saurav.kumar@example.com")
    json.update("line_items[0].name", value: "Crate of Red Herbs")
    json.update("line_items[0].description", value: "Red Herbs from Resident Evil")
    json.updateInt("line_items[0].amount", value: 50000)
    json.update("line_items[0].currency", value: "INR")
    json.updateInt("line_items[0].quantity", value: 5)
    json.update("line_items[1].item_id", value: "{item_id}")
    json.updateInt("sms_notify", value: 1)
    json.updateInt("email_notify", value: 1)
    json.update("draft", value: "1")
    json.updateInt("date", value: 1588076279)
    json.updateInt("expire_by", value: 1924991999)
    json.update("receipt", value: "Receipt No. 1")
    json.update("comment", value: "Fresh herbs mowed this morning")
    json.update("terms", value: "No Returns; No Refunds")
    json.update("notes.notes_key_1", value: "Beam me up Scotty.")
    json.update("notes.notes_key_2", value: "Engage")

    http.setRequestHeader("Content-Type", value: "application/json")

    let sbRequestBody = CkoStringBuilder()!
    json.emitSb(sbRequestBody)

    var resp: CkoHttpResponse? = http.pTextSb("PATCH", url: "https://api.razorpay.com/v1/invoices/{inv_id}", textData: sbRequestBody, charset: "utf-8", contentType: "application/json", md5: false, gzip: false)
    if http.lastMethodSuccess == false {
        print("\(http.lastErrorText!)")
        return
    }

    print("\(resp!.statusCode.intValue)")
    print("\(resp!.bodyStr!)")
    resp = nil

}

Curl Command

curl -X PATCH
	-u 'username:password'
	-H "Content-Type: application/json"
	-d '{
    "partial_payment": true,
    "customer": {
        "name": "Saurav Kumar",
        "contact": "9123456789",
        "email": "saurav.kumar@example.com"
    },
    "line_items": [
        {
            "name": "Crate of Red Herbs",
            "description": "Red Herbs from Resident Evil",
            "amount": 50000,
            "currency": "INR",
            "quantity": 5
        },
        {
            "item_id": "{item_id}"
        }
    ],
    "sms_notify": 1,
    "email_notify": 1,
    "draft": "1",
    "date": 1588076279,
    "expire_by": 1924991999,
    "receipt": "Receipt No. 1",
    "comment": "Fresh herbs mowed this morning",
    "terms": "No Returns; No Refunds",
    "notes": {
        "notes_key_1": "Beam me up Scotty.",
        "notes_key_2": "Engage"
    }
}'
https://api.razorpay.com/v1/invoices/{inv_id}

Postman Collection Item JSON

{
  "name": "Update an Invoice",
  "request": {
    "method": "PATCH",
    "header": [
      {
        "key": "Content-Type",
        "name": "Content-Type",
        "type": "text",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"partial_payment\": true,\n    \"customer\": {\n        \"name\": \"Saurav Kumar\",\n        \"contact\": \"9123456789\",\n        \"email\": \"saurav.kumar@example.com\"\n    },\n    \"line_items\": [\n        {\n            \"name\": \"Crate of Red Herbs\",\n            \"description\": \"Red Herbs from Resident Evil\",\n            \"amount\": 50000,\n            \"currency\": \"INR\",\n            \"quantity\": 5\n        },\n        {\n            \"item_id\": \"{item_id}\"\n        }\n    ],\n    \"sms_notify\": 1,\n    \"email_notify\": 1,\n    \"draft\": \"1\",\n    \"date\": 1588076279,\n    \"expire_by\": 1924991999,\n    \"receipt\": \"Receipt No. 1\",\n    \"comment\": \"Fresh herbs mowed this morning\",\n    \"terms\": \"No Returns; No Refunds\",\n    \"notes\": {\n        \"notes_key_1\": \"Beam me up Scotty.\",\n        \"notes_key_2\": \"Engage\"\n    }\n}"
    },
    "url": {
      "raw": "https://api.razorpay.com/v1/invoices/{inv_id}",
      "protocol": "https",
      "host": [
        "api",
        "razorpay",
        "com"
      ],
      "path": [
        "v1",
        "invoices",
        "{inv_id}"
      ],
      "query": [
        {
          "key": "count",
          "value": "10",
          "disabled": true
        },
        {
          "key": "skip",
          "value": "10",
          "disabled": true
        }
      ]
    },
    "description": "Update an invoice using this API.\n\nKnow more about the <a href=\"https://razorpay.com/docs/api/invoices/#update-an-invoice\" target=\"_blank\">Update an Invoice API</a>."
  },
  "response": [
  ]
}