Chilkat Online Tools

TCL / easybill REST API / Fetch SEPA payment

Back to Collection Items

load ./chilkat.dll

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

set http [new_CkHttp]

CkHttp_SetRequestHeader $http "Authorization" "{{apiKey}}"
CkHttp_SetRequestHeader $http "Accept" "application/json"

set sbResponseBody [new_CkStringBuilder]

set success [CkHttp_QuickGetSb $http "https://api.easybill.de/rest/v1/sepa-payments/:id" $sbResponseBody]
if {$success == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkStringBuilder $sbResponseBody
    exit
}

set jResp [new_CkJsonObject]

CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0

puts "Response Body:"
puts [CkJsonObject_emit $jResp]

set respStatusCode [CkHttp_get_LastStatus $http]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
    puts "Response Header:"
    puts [CkHttp_lastHeader $http]
    puts "Failed."
    delete_CkHttp $http
    delete_CkStringBuilder $sbResponseBody
    delete_CkJsonObject $jResp
    exit
}

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

# {
#   "document_id": "<long>",
#   "debitor_name": "<string>",
#   "debitor_iban": "<string>",
#   "mandate_id": "<string>",
#   "mandate_date_of_signature": "<date>",
#   "local_instrument": "COR1",
#   "sequence_type": "FRST",
#   "amount": "<integer>",
#   "reference": "<string>",
#   "created_at": "<dateTime>",
#   "creditor_bic": null,
#   "creditor_iban": "<string>",
#   "creditor_name": "<string>",
#   "debitor_bic": null,
#   "debitor_address_line_1": "<string>",
#   "debitor_address_line2": "<string>",
#   "debitor_country": "<string>",
#   "export_at": null,
#   "export_error": "<string>",
#   "id": "<long>",
#   "remittance_information": null,
#   "requested_at": "Today's date",
#   "updated_at": "<string>",
#   "type": "DEBIT"
# }

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

set document_id [CkJsonObject_stringOf $jResp "document_id"]
set debitor_name [CkJsonObject_stringOf $jResp "debitor_name"]
set debitor_iban [CkJsonObject_stringOf $jResp "debitor_iban"]
set mandate_id [CkJsonObject_stringOf $jResp "mandate_id"]
set mandate_date_of_signature [CkJsonObject_stringOf $jResp "mandate_date_of_signature"]
set local_instrument [CkJsonObject_stringOf $jResp "local_instrument"]
set sequence_type [CkJsonObject_stringOf $jResp "sequence_type"]
set amount [CkJsonObject_stringOf $jResp "amount"]
set reference [CkJsonObject_stringOf $jResp "reference"]
set created_at [CkJsonObject_stringOf $jResp "created_at"]
set creditor_bic [CkJsonObject_stringOf $jResp "creditor_bic"]
set creditor_iban [CkJsonObject_stringOf $jResp "creditor_iban"]
set creditor_name [CkJsonObject_stringOf $jResp "creditor_name"]
set debitor_bic [CkJsonObject_stringOf $jResp "debitor_bic"]
set debitor_address_line_1 [CkJsonObject_stringOf $jResp "debitor_address_line_1"]
set debitor_address_line2 [CkJsonObject_stringOf $jResp "debitor_address_line2"]
set debitor_country [CkJsonObject_stringOf $jResp "debitor_country"]
set export_at [CkJsonObject_stringOf $jResp "export_at"]
set export_error [CkJsonObject_stringOf $jResp "export_error"]
set id [CkJsonObject_stringOf $jResp "id"]
set remittance_information [CkJsonObject_stringOf $jResp "remittance_information"]
set requested_at [CkJsonObject_stringOf $jResp "requested_at"]
set updated_at [CkJsonObject_stringOf $jResp "updated_at"]
set v_type [CkJsonObject_stringOf $jResp "type"]

delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp

Curl Command

curl -X GET
	-H "Authorization: {{apiKey}}"
	-H "Accept: application/json"
https://api.easybill.de/rest/v1/sepa-payments/:id

Postman Collection Item JSON

{
  "name": "Fetch SEPA payment",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/sepa-payments/:id",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "sepa-payments",
        ":id"
      ],
      "variable": [
        {
          "key": "id",
          "value": "<long>",
          "description": "(Required) ID of SEPA payment"
        }
      ]
    }
  },
  "response": [
    {
      "name": "Successful operation",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "Authorization",
            "value": "<API Key>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/sepa-payments/:id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "sepa-payments",
            ":id"
          ],
          "variable": [
            {
              "key": "id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"document_id\": \"<long>\",\n  \"debitor_name\": \"<string>\",\n  \"debitor_iban\": \"<string>\",\n  \"mandate_id\": \"<string>\",\n  \"mandate_date_of_signature\": \"<date>\",\n  \"local_instrument\": \"COR1\",\n  \"sequence_type\": \"FRST\",\n  \"amount\": \"<integer>\",\n  \"reference\": \"<string>\",\n  \"created_at\": \"<dateTime>\",\n  \"creditor_bic\": null,\n  \"creditor_iban\": \"<string>\",\n  \"creditor_name\": \"<string>\",\n  \"debitor_bic\": null,\n  \"debitor_address_line_1\": \"<string>\",\n  \"debitor_address_line2\": \"<string>\",\n  \"debitor_country\": \"<string>\",\n  \"export_at\": null,\n  \"export_error\": \"<string>\",\n  \"id\": \"<long>\",\n  \"remittance_information\": null,\n  \"requested_at\": \"Today's date\",\n  \"updated_at\": \"<string>\",\n  \"type\": \"DEBIT\"\n}"
    },
    {
      "name": "Not found",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "Authorization",
            "value": "<API Key>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/sepa-payments/:id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "sepa-payments",
            ":id"
          ],
          "variable": [
            {
              "key": "id"
            }
          ]
        }
      },
      "status": "Not Found",
      "code": 404,
      "_postman_previewlanguage": "text",
      "header": [
      ],
      "cookie": [
      ],
      "body": ""
    },
    {
      "name": "Too Many Requests",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "Authorization",
            "value": "<API Key>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/sepa-payments/:id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "sepa-payments",
            ":id"
          ],
          "variable": [
            {
              "key": "id"
            }
          ]
        }
      },
      "status": "Too Many Requests",
      "code": 429,
      "_postman_previewlanguage": "text",
      "header": [
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}