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]
set queryParams [new_CkJsonObject]
CkJsonObject_UpdateString $queryParams "limit" "<integer>"
CkJsonObject_UpdateString $queryParams "page" "<integer>"
CkJsonObject_UpdateString $queryParams "document_id" "<string>"
CkHttp_SetRequestHeader $http "Authorization" "{{apiKey}}"
CkHttp_SetRequestHeader $http "Accept" "application/json"
# resp is a CkHttpResponse
set resp [CkHttp_QuickRequestParams $http "GET" "https://api.easybill.de/rest/v1/sepa-payments" $queryParams]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
puts [CkHttp_lastErrorText $http]
delete_CkHttp $http
delete_CkJsonObject $queryParams
exit
}
set sbResponseBody [new_CkStringBuilder]
CkHttpResponse_GetBodySb $resp $sbResponseBody
set jResp [new_CkJsonObject]
CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0
puts "Response Body:"
puts [CkJsonObject_emit $jResp]
set respStatusCode [CkHttpResponse_get_StatusCode $resp]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
puts "Response Header:"
puts [CkHttpResponse_header $resp]
puts "Failed."
delete_CkHttpResponse $resp
delete_CkHttp $http
delete_CkJsonObject $queryParams
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
exit
}
delete_CkHttpResponse $resp
# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)
# {
# "page": "<integer>",
# "pages": "<integer>",
# "limit": "<integer>",
# "total": "<integer>",
# "items": [
# {
# "document_id": "<long>",
# "debitor_name": "<string>",
# "debitor_iban": "<string>",
# "mandate_id": "<string>",
# "mandate_date_of_signature": "<date>",
# "local_instrument": "B2B",
# "sequence_type": "RCUR",
# "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"
# },
# {
# "document_id": "<long>",
# "debitor_name": "<string>",
# "debitor_iban": "<string>",
# "mandate_id": "<string>",
# "mandate_date_of_signature": "<date>",
# "local_instrument": "COR1",
# "sequence_type": "FNAL",
# "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 page [CkJsonObject_stringOf $jResp "page"]
set pages [CkJsonObject_stringOf $jResp "pages"]
set limit [CkJsonObject_stringOf $jResp "limit"]
set total [CkJsonObject_stringOf $jResp "total"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "items"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set document_id [CkJsonObject_stringOf $jResp "items[i].document_id"]
set debitor_name [CkJsonObject_stringOf $jResp "items[i].debitor_name"]
set debitor_iban [CkJsonObject_stringOf $jResp "items[i].debitor_iban"]
set mandate_id [CkJsonObject_stringOf $jResp "items[i].mandate_id"]
set mandate_date_of_signature [CkJsonObject_stringOf $jResp "items[i].mandate_date_of_signature"]
set local_instrument [CkJsonObject_stringOf $jResp "items[i].local_instrument"]
set sequence_type [CkJsonObject_stringOf $jResp "items[i].sequence_type"]
set amount [CkJsonObject_stringOf $jResp "items[i].amount"]
set reference [CkJsonObject_stringOf $jResp "items[i].reference"]
set created_at [CkJsonObject_stringOf $jResp "items[i].created_at"]
set creditor_bic [CkJsonObject_stringOf $jResp "items[i].creditor_bic"]
set creditor_iban [CkJsonObject_stringOf $jResp "items[i].creditor_iban"]
set creditor_name [CkJsonObject_stringOf $jResp "items[i].creditor_name"]
set debitor_bic [CkJsonObject_stringOf $jResp "items[i].debitor_bic"]
set debitor_address_line_1 [CkJsonObject_stringOf $jResp "items[i].debitor_address_line_1"]
set debitor_address_line2 [CkJsonObject_stringOf $jResp "items[i].debitor_address_line2"]
set debitor_country [CkJsonObject_stringOf $jResp "items[i].debitor_country"]
set export_at [CkJsonObject_stringOf $jResp "items[i].export_at"]
set export_error [CkJsonObject_stringOf $jResp "items[i].export_error"]
set id [CkJsonObject_stringOf $jResp "items[i].id"]
set remittance_information [CkJsonObject_stringOf $jResp "items[i].remittance_information"]
set requested_at [CkJsonObject_stringOf $jResp "items[i].requested_at"]
set updated_at [CkJsonObject_stringOf $jResp "items[i].updated_at"]
set v_type [CkJsonObject_stringOf $jResp "items[i].type"]
set i [expr $i + 1]
}
delete_CkHttp $http
delete_CkJsonObject $queryParams
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
Curl Command
curl -G -d "limit=%3Cinteger%3E"
-d "page=%3Cinteger%3E"
-d "document_id=%3Cstring%3E"
-H "Authorization: {{apiKey}}"
-H "Accept: application/json"
https://api.easybill.de/rest/v1/sepa-payments
Postman Collection Item JSON
{
"name": "Fetch SEPA payments list",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/sepa-payments?limit=<integer>&page=<integer>&document_id=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"sepa-payments"
],
"query": [
{
"key": "limit",
"value": "<integer>",
"description": "Limited the result. Default is 100. Maximum can be 1000."
},
{
"key": "page",
"value": "<integer>",
"description": "Set current Page. Default is 1."
},
{
"key": "document_id",
"value": "<string>",
"description": "Filter SEPA payment by document_id. You can add multiple ids separate by comma like id,id,id."
}
]
}
},
"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?limit=<integer>&page=<integer>&document_id=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"sepa-payments"
],
"query": [
{
"key": "limit",
"value": "<integer>",
"description": "Limited the result. Default is 100. Maximum can be 1000."
},
{
"key": "page",
"value": "<integer>",
"description": "Set current Page. Default is 1."
},
{
"key": "document_id",
"value": "<string>",
"description": "Filter SEPA payment by document_id. You can add multiple ids separate by comma like id,id,id."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"page\": \"<integer>\",\n \"pages\": \"<integer>\",\n \"limit\": \"<integer>\",\n \"total\": \"<integer>\",\n \"items\": [\n {\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\": \"B2B\",\n \"sequence_type\": \"RCUR\",\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 },\n {\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\": \"FNAL\",\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 }\n ]\n}"
},
{
"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?limit=<integer>&page=<integer>&document_id=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"sepa-payments"
],
"query": [
{
"key": "limit",
"value": "<integer>",
"description": "Limited the result. Default is 100. Maximum can be 1000."
},
{
"key": "page",
"value": "<integer>",
"description": "Set current Page. Default is 1."
},
{
"key": "document_id",
"value": "<string>",
"description": "Filter SEPA payment by document_id. You can add multiple ids separate by comma like id,id,id."
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "text",
"header": [
],
"cookie": [
],
"body": ""
}
]
}
