Chilkat Online Tools

C / easybill REST API / Update SEPA payment

Back to Collection Items

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

void ChilkatSample(void)
    {
    HCkHttp http;
    BOOL success;
    HCkJsonObject json;
    HCkStringBuilder sbRequestBody;
    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;

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

    http = CkHttp_Create();

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

    // The following JSON is sent in the request body.

    // {
    //   "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"
    // }

    json = CkJsonObject_Create();
    CkJsonObject_UpdateString(json,"document_id","<long>");
    CkJsonObject_UpdateString(json,"debitor_name","<string>");
    CkJsonObject_UpdateString(json,"debitor_iban","<string>");
    CkJsonObject_UpdateString(json,"mandate_id","<string>");
    CkJsonObject_UpdateString(json,"mandate_date_of_signature","<date>");
    CkJsonObject_UpdateString(json,"local_instrument","COR1");
    CkJsonObject_UpdateString(json,"sequence_type","FRST");
    CkJsonObject_UpdateString(json,"amount","<integer>");
    CkJsonObject_UpdateString(json,"reference","<string>");
    CkJsonObject_UpdateString(json,"created_at","<dateTime>");
    CkJsonObject_UpdateNull(json,"creditor_bic");
    CkJsonObject_UpdateString(json,"creditor_iban","<string>");
    CkJsonObject_UpdateString(json,"creditor_name","<string>");
    CkJsonObject_UpdateNull(json,"debitor_bic");
    CkJsonObject_UpdateString(json,"debitor_address_line_1","<string>");
    CkJsonObject_UpdateString(json,"debitor_address_line2","<string>");
    CkJsonObject_UpdateString(json,"debitor_country","<string>");
    CkJsonObject_UpdateNull(json,"export_at");
    CkJsonObject_UpdateString(json,"export_error","<string>");
    CkJsonObject_UpdateString(json,"id","<long>");
    CkJsonObject_UpdateNull(json,"remittance_information");
    CkJsonObject_UpdateString(json,"requested_at","Today's date");
    CkJsonObject_UpdateString(json,"updated_at","<string>");
    CkJsonObject_UpdateString(json,"type","DEBIT");

    CkHttp_SetRequestHeader(http,"Content-Type","application/json");
    CkHttp_SetRequestHeader(http,"Authorization","{{apiKey}}");
    CkHttp_SetRequestHeader(http,"Accept","application/json");

    sbRequestBody = CkStringBuilder_Create();
    CkJsonObject_EmitSb(json,sbRequestBody);

    resp = CkHttp_PTextSb(http,"PUT","https://api.easybill.de/rest/v1/sepa-payments/:id",sbRequestBody,"utf-8","application/json",FALSE,FALSE);
    if (CkHttp_getLastMethodSuccess(http) == FALSE) {
        printf("%s\n",CkHttp_lastErrorText(http));
        CkHttp_Dispose(http);
        CkJsonObject_Dispose(json);
        CkStringBuilder_Dispose(sbRequestBody);
        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(json);
        CkStringBuilder_Dispose(sbRequestBody);
        CkStringBuilder_Dispose(sbResponseBody);
        CkJsonObject_Dispose(jResp);
        return;
    }

    CkHttpResponse_Dispose(resp);

    // 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

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

    document_id = CkJsonObject_stringOf(jResp,"document_id");
    debitor_name = CkJsonObject_stringOf(jResp,"debitor_name");
    debitor_iban = CkJsonObject_stringOf(jResp,"debitor_iban");
    mandate_id = CkJsonObject_stringOf(jResp,"mandate_id");
    mandate_date_of_signature = CkJsonObject_stringOf(jResp,"mandate_date_of_signature");
    local_instrument = CkJsonObject_stringOf(jResp,"local_instrument");
    sequence_type = CkJsonObject_stringOf(jResp,"sequence_type");
    amount = CkJsonObject_stringOf(jResp,"amount");
    reference = CkJsonObject_stringOf(jResp,"reference");
    created_at = CkJsonObject_stringOf(jResp,"created_at");
    creditor_bic = CkJsonObject_stringOf(jResp,"creditor_bic");
    creditor_iban = CkJsonObject_stringOf(jResp,"creditor_iban");
    creditor_name = CkJsonObject_stringOf(jResp,"creditor_name");
    debitor_bic = CkJsonObject_stringOf(jResp,"debitor_bic");
    debitor_address_line_1 = CkJsonObject_stringOf(jResp,"debitor_address_line_1");
    debitor_address_line2 = CkJsonObject_stringOf(jResp,"debitor_address_line2");
    debitor_country = CkJsonObject_stringOf(jResp,"debitor_country");
    export_at = CkJsonObject_stringOf(jResp,"export_at");
    export_error = CkJsonObject_stringOf(jResp,"export_error");
    id = CkJsonObject_stringOf(jResp,"id");
    remittance_information = CkJsonObject_stringOf(jResp,"remittance_information");
    requested_at = CkJsonObject_stringOf(jResp,"requested_at");
    updated_at = CkJsonObject_stringOf(jResp,"updated_at");
    v_type = CkJsonObject_stringOf(jResp,"type");


    CkHttp_Dispose(http);
    CkJsonObject_Dispose(json);
    CkStringBuilder_Dispose(sbRequestBody);
    CkStringBuilder_Dispose(sbResponseBody);
    CkJsonObject_Dispose(jResp);

    }

Curl Command

curl -X PUT
	-H "Authorization: {{apiKey}}"
	-H "Content-Type: application/json"
	-H "Accept: application/json"
	-d '{
  "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"
}'
https://api.easybill.de/rest/v1/sepa-payments/:id

Postman Collection Item JSON

{
  "name": "Update SEPA payment",
  "request": {
    "method": "PUT",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      },
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\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}",
      "options": {
        "raw": {
          "headerFamily": "json",
          "language": "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": "PUT",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          },
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "Authorization",
            "value": "<API Key>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\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}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "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": "Invalid SEPA payment",
      "originalRequest": {
        "method": "PUT",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "Authorization",
            "value": "<API Key>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\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}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/sepa-payments/:id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "sepa-payments",
            ":id"
          ],
          "variable": [
            {
              "key": "id"
            }
          ]
        }
      },
      "status": "Bad Request",
      "code": 400,
      "_postman_previewlanguage": "text",
      "header": [
      ],
      "cookie": [
      ],
      "body": ""
    },
    {
      "name": "Too Many Requests",
      "originalRequest": {
        "method": "PUT",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "Authorization",
            "value": "<API Key>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\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}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "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": ""
    }
  ]
}