Chilkat Online Tools

SQL Server / GP-API Collection / DAA_1.0 Get Deposit List

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

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

    EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'account_name', '{{settlement_acc_name}}'
    EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'from_time_created', '2020-12-26'

    -- Adds the "Authorization: Bearer {{token}}" header.
    EXEC sp_OASetProperty @http, 'AuthToken', '{{token}}'
    EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'X-GP-Version', '2020-04-10'

    DECLARE @resp int
    EXEC sp_OAMethod @http, 'QuickRequestParams', @resp OUT, 'GET', 'https://{{url}}/ucp/settlement/deposits', @queryParams
    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 @queryParams
        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 @queryParams


END
GO

Curl Command

curl -G -d "account_name=%7B%7Bsettlement_acc_name%7D%7D"
	-d "from_time_created=2020-12-26"
	-H "Authorization: Bearer {{token}}"
	-H "X-GP-Version: 2020-04-10"
https://{{url}}/ucp/settlement/deposits

Postman Collection Item JSON

{
  "name": "DAA_1.0 Get Deposit List",
  "event": [
    {
      "listen": "test",
      "script": {
        "exec": [
          "\r",
          "\r",
          "tests[\"Response time is acceptable\"] = _.inRange(responseTime, 100, 1500); \r",
          "\r",
          "\r",
          "pm.test(\"Successful POST request\", function () {\r",
          "    pm.expect(pm.response.code).to.be.oneOf([200,201,202]);\r",
          "});\r",
          "\r",
          "pm.test(\"Status code name has string\", function () {\r",
          "    pm.response.to.have.status(\"OK\");\r",
          "});"
        ],
        "type": "text/javascript"
      }
    }
  ],
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Authorization",
        "value": "Bearer {{token}}",
        "type": "text"
      },
      {
        "key": "X-GP-Version",
        "value": "2020-04-10",
        "type": "text"
      }
    ],
    "url": {
      "raw": "https://{{url}}/ucp/settlement/deposits?account_name={{settlement_acc_name}}&from_time_created=2020-12-26",
      "protocol": "https",
      "host": [
        "{{url}}"
      ],
      "path": [
        "ucp",
        "settlement",
        "deposits"
      ],
      "query": [
        {
          "key": "account_name",
          "value": "{{settlement_acc_name}}"
        },
        {
          "key": "from_time_created",
          "value": "2020-12-26"
        },
        {
          "key": "system.hierarchy",
          "value": "",
          "disabled": true
        }
      ]
    },
    "description": "This request returns a list of all deposits for a merchant from a specific date. Deposits make up all Debits and Credits made to a merchants bank a/c. To change the date of how far back in time the report goes to, edit the from_time_created variable in the Params tab to whatever date you would like. It is recommended to go at least 10 days back in time.\r\n\r\nTo find out more info on getting deposit list, visit: https://developer.globalpay.com/api/deposits#/Deposits/get_deposits"
  },
  "response": [
  ]
}