Chilkat Online Tools

SQL Server / Razorpay APIs / Idempotent Request

Back to Collection Items

-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
    DECLARE @hr int
    DECLARE @iTmp0 int
    -- Important: Do not use nvarchar(max).  See the warning about using nvarchar(max).
    DECLARE @sTmp0 nvarchar(4000)
    -- This example assumes the Chilkat API to have been previously unlocked.
    -- See Global Unlock Sample for sample code.

    DECLARE @http int
    -- Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.Http', @http OUT
    IF @hr <> 0
    BEGIN
        PRINT 'Failed to create ActiveX component'
        RETURN
    END

    DECLARE @success int

    EXEC sp_OASetProperty @http, 'BasicAuth', 1
    EXEC sp_OASetProperty @http, 'Login', 'username'
    EXEC sp_OASetProperty @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.

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

    DECLARE @json int
    -- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @json OUT

    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'account_number', '7878780080316316'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'fund_account_id', 'fa_00000000000001'
    EXEC sp_OAMethod @json, 'UpdateInt', @success OUT, 'amount', 1000000
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'currency', 'INR'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'mode', 'IMPS'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'purpose', 'refund'
    EXEC sp_OAMethod @json, 'UpdateBool', @success OUT, 'queue_if_low_balance', 1
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'reference_id', 'Acme Transaction ID 12345'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'narration', 'Acme Corp Fund Transfer'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'notes.notes_key_1', 'Tea, Earl Grey, Hot'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'notes.notes_key_2', 'Tea, Earl Grey… decaf.'

    EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'X-Payout-Idempotency', '53cda91c-8f81-4e77-bbb9-7388f4ac6bf4'

    DECLARE @resp int
    EXEC sp_OAMethod @http, 'PostJson3', @resp OUT, 'https://api.razorpay.com/v1/payouts', 'application/json', @json
    EXEC sp_OAGetProperty @http, 'LastMethodSuccess', @iTmp0 OUT
    IF @iTmp0 = 0
      BEGIN
        EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @http
        EXEC @hr = sp_OADestroy @json
        RETURN
      END

    EXEC sp_OAGetProperty @resp, 'StatusCode', @iTmp0 OUT
    PRINT @iTmp0
    EXEC sp_OAGetProperty @resp, 'BodyStr', @sTmp0 OUT
    PRINT @sTmp0
    EXEC @hr = sp_OADestroy @resp


    EXEC @hr = sp_OADestroy @http
    EXEC @hr = sp_OADestroy @json


END
GO

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