Chilkat Online Tools

TCL / Razorpay APIs / Idempotent Request

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.

# {
#   "account_number": "7878780080316316",
#   "fund_account_id": "fa_00000000000001",
#   "amount": 1000000,
#   "currency": "INR",
#   "mode": "IMPS",
#   "purpose": "refund",
#   "queue_if_low_balance": true,
#   "reference_id": "Acme Transaction ID 12345",
#   "narration": "Acme Corp Fund Transfer",
#   "notes": {
#     "notes_key_1": "Tea, Earl Grey, Hot",
#     "notes_key_2": "Tea, Earl Grey… decaf."
#   }
# }

set json [new_CkJsonObject]

CkJsonObject_UpdateString $json "account_number" "7878780080316316"
CkJsonObject_UpdateString $json "fund_account_id" "fa_00000000000001"
CkJsonObject_UpdateInt $json "amount" 1000000
CkJsonObject_UpdateString $json "currency" "INR"
CkJsonObject_UpdateString $json "mode" "IMPS"
CkJsonObject_UpdateString $json "purpose" "refund"
CkJsonObject_UpdateBool $json "queue_if_low_balance" 1
CkJsonObject_UpdateString $json "reference_id" "Acme Transaction ID 12345"
CkJsonObject_UpdateString $json "narration" "Acme Corp Fund Transfer"
CkJsonObject_UpdateString $json "notes.notes_key_1" "Tea, Earl Grey, Hot"
CkJsonObject_UpdateString $json "notes.notes_key_2" "Tea, Earl Grey… decaf."

CkHttp_SetRequestHeader $http "X-Payout-Idempotency" "53cda91c-8f81-4e77-bbb9-7388f4ac6bf4"

# resp is a CkHttpResponse
set resp [CkHttp_PostJson3 $http "https://api.razorpay.com/v1/payouts" "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'
	-H "X-Payout-Idempotency: 53cda91c-8f81-4e77-bbb9-7388f4ac6bf4"
	-d '{
  "account_number": "7878780080316316",
  "fund_account_id": "fa_00000000000001",
  "amount": 1000000,
  "currency": "INR",
  "mode": "IMPS",
  "purpose": "refund",
  "queue_if_low_balance": true,
  "reference_id": "Acme Transaction ID 12345",
  "narration": "Acme Corp Fund Transfer",
  "notes": {
    "notes_key_1":"Tea, Earl Grey, Hot",
    "notes_key_2":"Tea, Earl Grey… decaf."
  }
}'
https://api.razorpay.com/v1/payouts

Postman Collection Item JSON

{
  "name": "Idempotent Request",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "X-Payout-Idempotency",
        "value": "53cda91c-8f81-4e77-bbb9-7388f4ac6bf4",
        "type": "text"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"account_number\": \"7878780080316316\",\n  \"fund_account_id\": \"fa_00000000000001\",\n  \"amount\": 1000000,\n  \"currency\": \"INR\",\n  \"mode\": \"IMPS\",\n  \"purpose\": \"refund\",\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\":\"Tea, Earl Grey, Hot\",\n    \"notes_key_2\":\"Tea, Earl Grey… decaf.\"\n  }\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "https://api.razorpay.com/v1/payouts",
      "protocol": "https",
      "host": [
        "api",
        "razorpay",
        "com"
      ],
      "path": [
        "v1",
        "payouts"
      ]
    },
    "description": "To make a request idempotent, add the header `X-Payout-Idempotency` to the request and pass an idempotency key against it.\n\nAn idempotency key is a unique value generated by you. Our servers use this key to recognize subsequent retries of the same request.\n\nThe idempotency key (4-36 characters) can only contain alphabets, numbers, hyphens, underscores and space. For example, `53cda91c-8f81-4e77-bbb9-7388f4ac6bf4`. We recommend you generate the key using a version 4 (random) UUID generator.\n\nKnow more about [Idempotent Requests](https://razorpay.com/docs/api/razorpayx/idempotency/)."
  },
  "response": [
  ]
}