Chilkat Online Tools

Swift / Belvo API Docs / Detail

Back to Collection Items

func chilkatTest() {
    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    let http = CkoHttp()
    var success: Bool

    http.BasicAuth = true
    http.Login = "{{secretId}}"
    http.Password = "{{secretPassword}}"

    let sbResponseBody = CkoStringBuilder()
    success = http.QuickGetSb("https://domain.com/api/statements/:id/", sbContent: sbResponseBody)
    if success == false {
        print("\(http.LastErrorText)")
        return
    }

    let jResp = CkoJsonObject()
    jResp.LoadSb(sbResponseBody)
    jResp.EmitCompact = false

    print("Response Body:")
    print("\(jResp.Emit())")

    var respStatusCode: Int = http.LastStatus.intValue
    print("Response Status Code = \(respStatusCode)")
    if respStatusCode >= 400 {
        print("Response Header:")
        print("\(http.LastHeader)")
        print("Failed.")
        return
    }

    // Sample JSON response:
    // (Sample code for parsing the JSON response is shown below)

    // {
    //   "id": "<uuid>",
    //   "link": "<string>",
    //   "account": {
    //     "id": "<uuid>",
    //     "name": "<string>",
    //     "category": "non consequat",
    //     "currency": "<string>"
    //   },
    //   "collected_at": "<dateTime>",
    //   "account_number": "<string>",
    //   "client_number": "<string>",
    //   "RFC": "<string>",
    //   "CLABE": "<string>",
    //   "period_start_date": "<date>",
    //   "period_end_date": "<date>",
    //   "cut_date": "<string>",
    //   "final_balance": "<number>",
    //   "previous_balance": "<number>",
    //   "total_inflow_amount": "<number>",
    //   "total_outflow_amount": "<number>",
    //   "total_inflow_transactions": "<number>",
    //   "total_outflow_transactions": "<number>",
    //   "transactions": [
    //     {
    //       "collected_at": {
    //         "value": "<Error: Too many levels of nesting to fake this schema>"
    //       },
    //       "accounting_date": {
    //         "value": "<Error: Too many levels of nesting to fake this schema>"
    //       },
    //       "value_date": {
    //         "value": "<Error: Too many levels of nesting to fake this schema>"
    //       },
    //       "reference": {
    //         "value": "<Error: Too many levels of nesting to fake this schema>"
    //       },
    //       "observations": {
    //         "value": "<Error: Too many levels of nesting to fake this schema>"
    //       },
    //       "additional_data": {
    //         "value": "<Error: Too many levels of nesting to fake this schema>"
    //       },
    //       "balance": {
    //         "value": "<Error: Too many levels of nesting to fake this schema>"
    //       },
    //       "status": {
    //         "value": "<Error: Too many levels of nesting to fake this schema>"
    //       },
    //       "type": {
    //         "value": "<Error: Too many levels of nesting to fake this schema>"
    //       },
    //       "currency": {
    //         "value": "<Error: Too many levels of nesting to fake this schema>"
    //       },
    //       "description": {
    //         "value": "<Error: Too many levels of nesting to fake this schema>"
    //       },
    //       "internal_identification": {
    //         "value": "<Error: Too many levels of nesting to fake this schema>"
    //       },
    //       "account": {
    //         "value": "<Error: Too many levels of nesting to fake this schema>"
    //       }
    //     },
    //     {
    //       "collected_at": {
    //         "value": "<Error: Too many levels of nesting to fake this schema>"
    //       },
    //       "accounting_date": {
    //         "value": "<Error: Too many levels of nesting to fake this schema>"
    //       },
    //       "value_date": {
    //         "value": "<Error: Too many levels of nesting to fake this schema>"
    //       },
    //       "reference": {
    //         "value": "<Error: Too many levels of nesting to fake this schema>"
    //       },
    //       "observations": {
    //         "value": "<Error: Too many levels of nesting to fake this schema>"
    //       },
    //       "additional_data": {
    //         "value": "<Error: Too many levels of nesting to fake this schema>"
    //       },
    //       "balance": {
    //         "value": "<Error: Too many levels of nesting to fake this schema>"
    //       },
    //       "status": {
    //         "value": "<Error: Too many levels of nesting to fake this schema>"
    //       },
    //       "type": {
    //         "value": "<Error: Too many levels of nesting to fake this schema>"
    //       },
    //       "currency": {
    //         "value": "<Error: Too many levels of nesting to fake this schema>"
    //       },
    //       "description": {
    //         "value": "<Error: Too many levels of nesting to fake this schema>"
    //       },
    //       "internal_identification": {
    //         "value": "<Error: Too many levels of nesting to fake this schema>"
    //       },
    //       "account": {
    //         "value": "<Error: Too many levels of nesting to fake this schema>"
    //       }
    //     }
    //   ],
    //   "pdf": "<binary>"
    // }

    // Sample code for parsing the JSON response...
    // Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

    var Value: String?
    var accounting_dateValue: String?
    var value_dateValue: String?
    var referenceValue: String?
    var observationsValue: String?
    var additional_dataValue: String?
    var balanceValue: String?
    var statusValue: String?
    var typeValue: String?
    var currencyValue: String?
    var descriptionValue: String?
    var internal_identificationValue: String?
    var accountValue: String?

    var id: String? = jResp.StringOf("id")
    var link: String? = jResp.StringOf("link")
    var Id: String? = jResp.StringOf("account.id")
    var Name: String? = jResp.StringOf("account.name")
    var Category: String? = jResp.StringOf("account.category")
    var v_Currency: String? = jResp.StringOf("account.currency")
    var collected_at: String? = jResp.StringOf("collected_at")
    var account_number: String? = jResp.StringOf("account_number")
    var client_number: String? = jResp.StringOf("client_number")
    var RFC: String? = jResp.StringOf("RFC")
    var CLABE: String? = jResp.StringOf("CLABE")
    var period_start_date: String? = jResp.StringOf("period_start_date")
    var period_end_date: String? = jResp.StringOf("period_end_date")
    var cut_date: String? = jResp.StringOf("cut_date")
    var final_balance: String? = jResp.StringOf("final_balance")
    var previous_balance: String? = jResp.StringOf("previous_balance")
    var total_inflow_amount: String? = jResp.StringOf("total_inflow_amount")
    var total_outflow_amount: String? = jResp.StringOf("total_outflow_amount")
    var total_inflow_transactions: String? = jResp.StringOf("total_inflow_transactions")
    var total_outflow_transactions: String? = jResp.StringOf("total_outflow_transactions")
    var pdf: String? = jResp.StringOf("pdf")
    var i: Int = 0
    var count_i: Int = jResp.SizeOfArray("transactions").intValue
    while i < count_i {
        jResp.I = i
        Value = jResp.StringOf("transactions[i].collected_at.value")
        accounting_dateValue = jResp.StringOf("transactions[i].accounting_date.value")
        value_dateValue = jResp.StringOf("transactions[i].value_date.value")
        referenceValue = jResp.StringOf("transactions[i].reference.value")
        observationsValue = jResp.StringOf("transactions[i].observations.value")
        additional_dataValue = jResp.StringOf("transactions[i].additional_data.value")
        balanceValue = jResp.StringOf("transactions[i].balance.value")
        statusValue = jResp.StringOf("transactions[i].status.value")
        typeValue = jResp.StringOf("transactions[i].type.value")
        currencyValue = jResp.StringOf("transactions[i].currency.value")
        descriptionValue = jResp.StringOf("transactions[i].description.value")
        internal_identificationValue = jResp.StringOf("transactions[i].internal_identification.value")
        accountValue = jResp.StringOf("transactions[i].account.value")
        i = i + 1
    }


}

Curl Command

curl -X GET
	-u '{{secretId}}:{{secretPassword}}'
https://domain.com/api/statements/:id/

Postman Collection Item JSON

{
  "name": "Detail",
  "request": {
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "{{baseUrl}}/api/statements/:id/",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "statements",
        ":id",
        ""
      ],
      "variable": [
        {
          "key": "id",
          "value": "consequa",
          "description": "(Required) The `statement.id` you want to get detailed information about."
        }
      ]
    },
    "description": "Get the details of a specific statement."
  },
  "response": [
    {
      "name": "Ok",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: basic",
            "key": "Authorization",
            "value": "Basic <credentials>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/statements/:id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "statements",
            ":id"
          ],
          "variable": [
            {
              "key": "id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n\t\"id\": \"<uuid>\",\n\t\"link\": \"<string>\",\n\t\"account\": {\n\t\t\"id\": \"<uuid>\",\n\t\t\"name\": \"<string>\",\n\t\t\"category\": \"non consequat\",\n\t\t\"currency\": \"<string>\"\n\t},\n\t\"collected_at\": \"<dateTime>\",\n\t\"account_number\": \"<string>\",\n\t\"client_number\": \"<string>\",\n\t\"RFC\": \"<string>\",\n\t\"CLABE\": \"<string>\",\n\t\"period_start_date\": \"<date>\",\n\t\"period_end_date\": \"<date>\",\n\t\"cut_date\": \"<string>\",\n\t\"final_balance\": \"<number>\",\n\t\"previous_balance\": \"<number>\",\n\t\"total_inflow_amount\": \"<number>\",\n\t\"total_outflow_amount\": \"<number>\",\n\t\"total_inflow_transactions\": \"<number>\",\n\t\"total_outflow_transactions\": \"<number>\",\n\t\"transactions\": [\n\t\t{\n\t\t\t\"collected_at\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"accounting_date\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"value_date\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"reference\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"observations\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"additional_data\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"balance\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"status\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"type\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"currency\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"description\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"internal_identification\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"account\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t}\n\t\t},\n\t\t{\n\t\t\t\"collected_at\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"accounting_date\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"value_date\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"reference\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"observations\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"additional_data\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"balance\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"status\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"type\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"currency\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"description\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"internal_identification\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"account\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t}\n\t\t}\n\t],\n\t\"pdf\": \"<binary>\"\n}"
    },
    {
      "name": "Unauthorized",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: basic",
            "key": "Authorization",
            "value": "Basic <credentials>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/statements/:id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "statements",
            ":id"
          ],
          "variable": [
            {
              "key": "id"
            }
          ]
        }
      },
      "status": "Unauthorized",
      "code": 401,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "[\n\t{\n\t\t\"code\": \"<string>\",\n\t\t\"message\": \"<string>\",\n\t\t\"request_id\": \"<string>\"\n\t},\n\t{\n\t\t\"code\": \"<string>\",\n\t\t\"message\": \"<string>\",\n\t\t\"request_id\": \"<string>\"\n\t}\n]"
    },
    {
      "name": "Too Many Sessions",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: basic",
            "key": "Authorization",
            "value": "Basic <credentials>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/statements/:id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "statements",
            ":id"
          ],
          "variable": [
            {
              "key": "id"
            }
          ]
        }
      },
      "status": "Not Found",
      "code": 404,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "[\n\t{\n\t\t\"code\": \"<string>\",\n\t\t\"message\": \"<string>\",\n\t\t\"request_id\": \"<string>\"\n\t},\n\t{\n\t\t\"code\": \"<string>\",\n\t\t\"message\": \"<string>\",\n\t\t\"request_id\": \"<string>\"\n\t}\n]"
    }
  ]
}