Chilkat Online Tools

VB6 / GP-API Collection / DAA_1.2 Get Transactions

Back to Collection Items

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

Dim http As New ChilkatHttp
Dim success As Long

Dim queryParams As New ChilkatJsonObject
success = queryParams.UpdateInt("page_size",1000)
success = queryParams.UpdateString("from_batch_time_created","2020-12-24")
success = queryParams.UpdateString("to_batch_time_created","2020-12-24")
success = queryParams.UpdateString("order","DESC")
success = queryParams.UpdateInt("page",1)
success = queryParams.UpdateString("account_name","{{settlement_acc_name}}")

' Adds the "Authorization: Bearer {{token}}" header.
http.AuthToken = "{{token}}"
http.SetRequestHeader "X-GP-Version","{{version}}"

Dim resp As ChilkatHttpResponse
Set resp = http.QuickRequestParams("GET","https://{{url}}/ucp/settlement/transactions",queryParams)
If (http.LastMethodSuccess = 0) Then
    Debug.Print http.LastErrorText
    Exit Sub
End If

Debug.Print resp.StatusCode
Debug.Print resp.BodyStr

Curl Command

curl -G -d "page_size=1000"
	-d "from_batch_time_created=2020-12-24"
	-d "to_batch_time_created=2020-12-24"
	-d "order=DESC"
	-d "page=1"
	-d "account_name=%7B%7Bsettlement_acc_name%7D%7D"
	-H "Authorization: Bearer {{token}}"
	-H "X-GP-Version: {{version}}"
https://{{url}}/ucp/settlement/transactions

Postman Collection Item JSON

{
  "name": "DAA_1.2 Get Transactions",
  "event": [
    {
      "listen": "test",
      "script": {
        "exec": [
          "\r",
          "pm.environment.unset(\"trn_id\");\r",
          "\r",
          "\r",
          "\r",
          "var jsonData = JSON.parse(responseBody);\r",
          "\r",
          "postman.setEnvironmentVariable(\"trn_id\", jsonData.transactions[0].id);\r",
          "\r",
          "tests[\"Transaction ID \" + pm.environment.get(\"trn_id\")] = true;\r",
          "\r",
          "\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": "{{version}}",
        "type": "text"
      }
    ],
    "url": {
      "raw": "https://{{url}}/ucp/settlement/transactions?page_size=1000&from_batch_time_created=2020-12-24&to_batch_time_created=2020-12-24&order=DESC&page=1&account_name={{settlement_acc_name}}",
      "protocol": "https",
      "host": [
        "{{url}}"
      ],
      "path": [
        "ucp",
        "settlement",
        "transactions"
      ],
      "query": [
        {
          "key": "page_size",
          "value": "1000"
        },
        {
          "key": "from_batch_time_created",
          "value": "2020-12-24"
        },
        {
          "key": "to_batch_time_created",
          "value": "2020-12-24"
        },
        {
          "key": "order",
          "value": "DESC"
        },
        {
          "key": "page",
          "value": "1"
        },
        {
          "key": "account_name",
          "value": "{{settlement_acc_name}}"
        },
        {
          "key": "status",
          "value": "FUNDED",
          "disabled": true
        },
        {
          "key": "system.hierarchy",
          "value": "",
          "disabled": true
        },
        {
          "key": "system.mid",
          "value": "",
          "disabled": true
        },
        {
          "key": "deposit_status",
          "value": "FUNDED",
          "disabled": true
        }
      ]
    },
    "description": "This request returns a list of all transactions done by a merchant from a specific date. \r\n- Page size indicates how many transactions are on one page of the report. 1000 is the max amount of records on one page.\r\n- Page variable is what page of the report the response is going to return. If you have less than 1000 transactions for the time period of the report, the report will only contain one page. \r\n- Edit the from_batch_time_created variable in the Params tab to change the date of how far back in time the report goes to. It is recommended to go at least 10 days back in time.\r\n\r\nFor more info on getting list of transactions, visit: https://developer.globalpay.com/api/transactions#/Transactions/get_settlement_transactions"
  },
  "response": [
  ]
}