Chilkat Online Tools

C / easybill REST API / Fetch SEPA payments list

Back to Collection Items

#include <C_CkHttp.h>
#include <C_CkJsonObject.h>
#include <C_CkHttpResponse.h>
#include <C_CkStringBuilder.h>

void ChilkatSample(void)
    {
    HCkHttp http;
    BOOL success;
    HCkJsonObject queryParams;
    HCkHttpResponse resp;
    HCkStringBuilder sbResponseBody;
    HCkJsonObject jResp;
    int respStatusCode;
    const char *document_id;
    const char *debitor_name;
    const char *debitor_iban;
    const char *mandate_id;
    const char *mandate_date_of_signature;
    const char *local_instrument;
    const char *sequence_type;
    const char *amount;
    const char *reference;
    const char *created_at;
    const char *creditor_bic;
    const char *creditor_iban;
    const char *creditor_name;
    const char *debitor_bic;
    const char *debitor_address_line_1;
    const char *debitor_address_line2;
    const char *debitor_country;
    const char *export_at;
    const char *export_error;
    const char *id;
    const char *remittance_information;
    const char *requested_at;
    const char *updated_at;
    const char *v_type;
    const char *page;
    const char *pages;
    const char *limit;
    const char *total;
    int i;
    int count_i;

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

    http = CkHttp_Create();

    queryParams = CkJsonObject_Create();
    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 = CkHttp_QuickRequestParams(http,"GET","https://api.easybill.de/rest/v1/sepa-payments",queryParams);
    if (CkHttp_getLastMethodSuccess(http) == FALSE) {
        printf("%s\n",CkHttp_lastErrorText(http));
        CkHttp_Dispose(http);
        CkJsonObject_Dispose(queryParams);
        return;
    }

    sbResponseBody = CkStringBuilder_Create();
    CkHttpResponse_GetBodySb(resp,sbResponseBody);

    jResp = CkJsonObject_Create();
    CkJsonObject_LoadSb(jResp,sbResponseBody);
    CkJsonObject_putEmitCompact(jResp,FALSE);

    printf("Response Body:\n");
    printf("%s\n",CkJsonObject_emit(jResp));

    respStatusCode = CkHttpResponse_getStatusCode(resp);
    printf("Response Status Code = %d\n",respStatusCode);
    if (respStatusCode >= 400) {
        printf("Response Header:\n");
        printf("%s\n",CkHttpResponse_header(resp));
        printf("Failed.\n");
        CkHttpResponse_Dispose(resp);
        CkHttp_Dispose(http);
        CkJsonObject_Dispose(queryParams);
        CkStringBuilder_Dispose(sbResponseBody);
        CkJsonObject_Dispose(jResp);
        return;
    }

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

    // Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.

    page = CkJsonObject_stringOf(jResp,"page");
    pages = CkJsonObject_stringOf(jResp,"pages");
    limit = CkJsonObject_stringOf(jResp,"limit");
    total = CkJsonObject_stringOf(jResp,"total");
    i = 0;
    count_i = CkJsonObject_SizeOfArray(jResp,"items");
    while (i < count_i) {
        CkJsonObject_putI(jResp,i);
        document_id = CkJsonObject_stringOf(jResp,"items[i].document_id");
        debitor_name = CkJsonObject_stringOf(jResp,"items[i].debitor_name");
        debitor_iban = CkJsonObject_stringOf(jResp,"items[i].debitor_iban");
        mandate_id = CkJsonObject_stringOf(jResp,"items[i].mandate_id");
        mandate_date_of_signature = CkJsonObject_stringOf(jResp,"items[i].mandate_date_of_signature");
        local_instrument = CkJsonObject_stringOf(jResp,"items[i].local_instrument");
        sequence_type = CkJsonObject_stringOf(jResp,"items[i].sequence_type");
        amount = CkJsonObject_stringOf(jResp,"items[i].amount");
        reference = CkJsonObject_stringOf(jResp,"items[i].reference");
        created_at = CkJsonObject_stringOf(jResp,"items[i].created_at");
        creditor_bic = CkJsonObject_stringOf(jResp,"items[i].creditor_bic");
        creditor_iban = CkJsonObject_stringOf(jResp,"items[i].creditor_iban");
        creditor_name = CkJsonObject_stringOf(jResp,"items[i].creditor_name");
        debitor_bic = CkJsonObject_stringOf(jResp,"items[i].debitor_bic");
        debitor_address_line_1 = CkJsonObject_stringOf(jResp,"items[i].debitor_address_line_1");
        debitor_address_line2 = CkJsonObject_stringOf(jResp,"items[i].debitor_address_line2");
        debitor_country = CkJsonObject_stringOf(jResp,"items[i].debitor_country");
        export_at = CkJsonObject_stringOf(jResp,"items[i].export_at");
        export_error = CkJsonObject_stringOf(jResp,"items[i].export_error");
        id = CkJsonObject_stringOf(jResp,"items[i].id");
        remittance_information = CkJsonObject_stringOf(jResp,"items[i].remittance_information");
        requested_at = CkJsonObject_stringOf(jResp,"items[i].requested_at");
        updated_at = CkJsonObject_stringOf(jResp,"items[i].updated_at");
        v_type = CkJsonObject_stringOf(jResp,"items[i].type");
        i = i + 1;
    }



    CkHttp_Dispose(http);
    CkJsonObject_Dispose(queryParams);
    CkStringBuilder_Dispose(sbResponseBody);
    CkJsonObject_Dispose(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": ""
    }
  ]
}