Chilkat Online Tools

Ruby / Belvo API Docs / Resume

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()

http.put_BasicAuth(true)
http.put_Login("{{secretId}}")
http.put_Password("{{secretPassword}}")

# Use this online tool to generate code from sample JSON: Generate Code to Create JSON

# The following JSON is sent in the request body.

# {
#   "session": "<uuid>",
#   "token": "<string>",
#   "link": "<uuid>",
#   "save_data": true
# }

json = Chilkat::CkJsonObject.new()
json.UpdateString("session","<uuid>")
json.UpdateString("token","<string>")
json.UpdateString("link","<uuid>")
json.UpdateBool("save_data",true)

sbRequestBody = Chilkat::CkStringBuilder.new()
json.EmitSb(sbRequestBody)

# resp is a CkHttpResponse
resp = http.PTextSb("PATCH","https://domain.com/api/recurring-expenses/",sbRequestBody,"utf-8","application/json",false,false)
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 -X PATCH
	-u '{{secretId}}:{{secretPassword}}'
	-d '{
    "session": "<uuid>",
    "token": "<string>",
    "link": "<uuid>",
    "save_data": true
}'
https://domain.com/api/recurring-expenses/

Postman Collection Item JSON

{
  "name": "Resume",
  "request": {
    "method": "PATCH",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"session\": \"<uuid>\",\n    \"token\": \"<string>\",\n    \"link\": \"<uuid>\",\n    \"save_data\": true\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{baseUrl}}/api/recurring-expenses/",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "recurring-expenses",
        ""
      ]
    },
    "description": "Used to resume an Recurring Expenses retrieve session that was paused because an MFA token was required by the institution."
  },
  "response": [
  ]
}