Chilkat Online Tools

PureBasic / Razorpay APIs / Idempotent Request

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.

    ; {
    ;   "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."
    ;   }
    ; }

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

    CkJsonObject::ckUpdateString(json,"account_number","7878780080316316")
    CkJsonObject::ckUpdateString(json,"fund_account_id","fa_00000000000001")
    CkJsonObject::ckUpdateInt(json,"amount",1000000)
    CkJsonObject::ckUpdateString(json,"currency","INR")
    CkJsonObject::ckUpdateString(json,"mode","IMPS")
    CkJsonObject::ckUpdateString(json,"purpose","refund")
    CkJsonObject::ckUpdateBool(json,"queue_if_low_balance",1)
    CkJsonObject::ckUpdateString(json,"reference_id","Acme Transaction ID 12345")
    CkJsonObject::ckUpdateString(json,"narration","Acme Corp Fund Transfer")
    CkJsonObject::ckUpdateString(json,"notes.notes_key_1","Tea, Earl Grey, Hot")
    CkJsonObject::ckUpdateString(json,"notes.notes_key_2","Tea, Earl Grey… decaf.")

    CkHttp::ckSetRequestHeader(http,"X-Payout-Idempotency","53cda91c-8f81-4e77-bbb9-7388f4ac6bf4")

    resp.i = CkHttp::ckPostJson3(http,"https://api.razorpay.com/v1/payouts","application/json",json)
    If CkHttp::ckLastMethodSuccess(http) = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(json)
        ProcedureReturn
    EndIf

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



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


    ProcedureReturn
EndProcedure

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