Chilkat Online Tools

SQL Server / PaymentsOS Testing with Mock Provider / 5. GET Void

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_OAMethod @http, 'SetRequestHeader', NULL, 'x-payments-os-env', '{{x-payments-os-env}}'
    EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Content-Type', 'application/json'
    EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'app_id', '{{app_id}}'
    EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'private_key', '{{private_key}}'
    EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'idempotency_key', '{{$randomInt}}'
    EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'api-version', '1.3.0'

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

    EXEC sp_OAMethod @http, 'QuickGetSb', @success OUT, 'https://api.paymentsos.com/payments/{{paymentid}}/voids/{{voidid}}', @sbResponseBody
    IF @success = 0
      BEGIN
        EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @http
        EXEC @hr = sp_OADestroy @sbResponseBody
        RETURN
      END


    EXEC sp_OAGetProperty @http, 'LastStatus', @iTmp0 OUT
    PRINT 'Response status code = ' + @iTmp0
    EXEC sp_OAMethod @sbResponseBody, 'GetAsString', @sTmp0 OUT
    PRINT @sTmp0

    EXEC @hr = sp_OADestroy @http
    EXEC @hr = sp_OADestroy @sbResponseBody


END
GO

Curl Command

curl -X GET
	-H "app_id: {{app_id}}"
	-H "private_key: {{private_key}}"
	-H "Content-Type: application/json"
	-H "api-version: 1.3.0"
	-H "x-payments-os-env: {{x-payments-os-env}}"
	-H "idempotency_key: {{$randomInt}}"
https://api.paymentsos.com/payments/{{paymentid}}/voids/{{voidid}}

Postman Collection Item JSON

{
  "name": "5. GET Void",
  "event": [
    {
      "listen": "test",
      "script": {
        "type": "text/javascript",
        "exec": [
          "var jsonData = JSON.parse(responseBody);",
          "postman.setEnvironmentVariable(\"authorizationid\", jsonData.id);"
        ]
      }
    }
  ],
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "app_id",
        "value": "{{app_id}}"
      },
      {
        "key": "private_key",
        "value": "{{private_key}}"
      },
      {
        "key": "Content-Type",
        "value": "application/json"
      },
      {
        "key": "api-version",
        "value": "1.3.0"
      },
      {
        "key": "x-payments-os-env",
        "value": "{{x-payments-os-env}}"
      },
      {
        "key": "idempotency_key",
        "value": "{{$randomInt}}"
      }
    ],
    "url": {
      "raw": "https://api.paymentsos.com/payments/{{paymentid}}/voids/{{voidid}}",
      "protocol": "https",
      "host": [
        "api",
        "paymentsos",
        "com"
      ],
      "path": [
        "payments",
        "{{paymentid}}",
        "voids",
        "{{voidid}}"
      ]
    },
    "description": "Create a new authorization"
  },
  "response": [
  ]
}