Chilkat Online Tools

Ruby / GP-API Collection / DAA_1.0 Get Deposit List

Back to Collection Items

require 'chilkat'

# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

http = Chilkat::CkHttp.new()

queryParams = Chilkat::CkJsonObject.new()
queryParams.UpdateString("account_name","{{settlement_acc_name}}")
queryParams.UpdateString("from_time_created","2020-12-26")

# Adds the "Authorization: Bearer {{token}}" header.
http.put_AuthToken("{{token}}")
http.SetRequestHeader("X-GP-Version","2020-04-10")

# resp is a CkHttpResponse
resp = http.QuickRequestParams("GET","https://{{url}}/ucp/settlement/deposits",queryParams)
if (http.get_LastMethodSuccess() == false)
    print http.lastErrorText() + "\n";
    exit
end

print resp.get_StatusCode().to_s() + "\n";
print resp.bodyStr() + "\n";

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