Back to Collection Items
#include <C_CkHttpW.h>
#include <C_CkJsonObjectW.h>
#include <C_CkStringBuilderW.h>
#include <C_CkHttpResponseW.h>
void ChilkatSample(void)
{
HCkHttpW http;
BOOL success;
HCkJsonObjectW json;
HCkStringBuilderW sbRequestBody;
HCkHttpResponseW resp;
HCkStringBuilderW sbResponseBody;
HCkJsonObjectW jResp;
int respStatusCode;
const wchar_t *document_id;
const wchar_t *debitor_name;
const wchar_t *debitor_iban;
const wchar_t *mandate_id;
const wchar_t *mandate_date_of_signature;
const wchar_t *local_instrument;
const wchar_t *sequence_type;
const wchar_t *amount;
const wchar_t *reference;
const wchar_t *created_at;
const wchar_t *creditor_bic;
const wchar_t *creditor_iban;
const wchar_t *creditor_name;
const wchar_t *debitor_bic;
const wchar_t *debitor_address_line_1;
const wchar_t *debitor_address_line2;
const wchar_t *debitor_country;
const wchar_t *export_at;
const wchar_t *export_error;
const wchar_t *id;
const wchar_t *remittance_information;
const wchar_t *requested_at;
const wchar_t *updated_at;
const wchar_t *v_type;
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http = CkHttpW_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 = CkJsonObjectW_Create();
CkJsonObjectW_UpdateString(json,L"document_id",L"<long>");
CkJsonObjectW_UpdateString(json,L"debitor_name",L"<string>");
CkJsonObjectW_UpdateString(json,L"debitor_iban",L"<string>");
CkJsonObjectW_UpdateString(json,L"mandate_id",L"<string>");
CkJsonObjectW_UpdateString(json,L"mandate_date_of_signature",L"<date>");
CkJsonObjectW_UpdateString(json,L"local_instrument",L"COR1");
CkJsonObjectW_UpdateString(json,L"sequence_type",L"FRST");
CkJsonObjectW_UpdateString(json,L"amount",L"<integer>");
CkJsonObjectW_UpdateString(json,L"reference",L"<string>");
CkJsonObjectW_UpdateString(json,L"created_at",L"<dateTime>");
CkJsonObjectW_UpdateNull(json,L"creditor_bic");
CkJsonObjectW_UpdateString(json,L"creditor_iban",L"<string>");
CkJsonObjectW_UpdateString(json,L"creditor_name",L"<string>");
CkJsonObjectW_UpdateNull(json,L"debitor_bic");
CkJsonObjectW_UpdateString(json,L"debitor_address_line_1",L"<string>");
CkJsonObjectW_UpdateString(json,L"debitor_address_line2",L"<string>");
CkJsonObjectW_UpdateString(json,L"debitor_country",L"<string>");
CkJsonObjectW_UpdateNull(json,L"export_at");
CkJsonObjectW_UpdateString(json,L"export_error",L"<string>");
CkJsonObjectW_UpdateString(json,L"id",L"<long>");
CkJsonObjectW_UpdateNull(json,L"remittance_information");
CkJsonObjectW_UpdateString(json,L"requested_at",L"Today's date");
CkJsonObjectW_UpdateString(json,L"updated_at",L"<string>");
CkJsonObjectW_UpdateString(json,L"type",L"DEBIT");
CkHttpW_SetRequestHeader(http,L"Content-Type",L"application/json");
CkHttpW_SetRequestHeader(http,L"Authorization",L"{{apiKey}}");
CkHttpW_SetRequestHeader(http,L"Accept",L"application/json");
sbRequestBody = CkStringBuilderW_Create();
CkJsonObjectW_EmitSb(json,sbRequestBody);
resp = CkHttpW_PTextSb(http,L"PUT",L"https://api.easybill.de/rest/v1/sepa-payments/:id",sbRequestBody,L"utf-8",L"application/json",FALSE,FALSE);
if (CkHttpW_getLastMethodSuccess(http) == FALSE) {
wprintf(L"%s\n",CkHttpW_lastErrorText(http));
CkHttpW_Dispose(http);
CkJsonObjectW_Dispose(json);
CkStringBuilderW_Dispose(sbRequestBody);
return;
}
sbResponseBody = CkStringBuilderW_Create();
CkHttpResponseW_GetBodySb(resp,sbResponseBody);
jResp = CkJsonObjectW_Create();
CkJsonObjectW_LoadSb(jResp,sbResponseBody);
CkJsonObjectW_putEmitCompact(jResp,FALSE);
wprintf(L"Response Body:\n");
wprintf(L"%s\n",CkJsonObjectW_emit(jResp));
respStatusCode = CkHttpResponseW_getStatusCode(resp);
wprintf(L"Response Status Code = %d\n",respStatusCode);
if (respStatusCode >= 400) {
wprintf(L"Response Header:\n");
wprintf(L"%s\n",CkHttpResponseW_header(resp));
wprintf(L"Failed.\n");
CkHttpResponseW_Dispose(resp);
CkHttpW_Dispose(http);
CkJsonObjectW_Dispose(json);
CkStringBuilderW_Dispose(sbRequestBody);
CkStringBuilderW_Dispose(sbResponseBody);
CkJsonObjectW_Dispose(jResp);
return;
}
CkHttpResponseW_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 = CkJsonObjectW_stringOf(jResp,L"document_id");
debitor_name = CkJsonObjectW_stringOf(jResp,L"debitor_name");
debitor_iban = CkJsonObjectW_stringOf(jResp,L"debitor_iban");
mandate_id = CkJsonObjectW_stringOf(jResp,L"mandate_id");
mandate_date_of_signature = CkJsonObjectW_stringOf(jResp,L"mandate_date_of_signature");
local_instrument = CkJsonObjectW_stringOf(jResp,L"local_instrument");
sequence_type = CkJsonObjectW_stringOf(jResp,L"sequence_type");
amount = CkJsonObjectW_stringOf(jResp,L"amount");
reference = CkJsonObjectW_stringOf(jResp,L"reference");
created_at = CkJsonObjectW_stringOf(jResp,L"created_at");
creditor_bic = CkJsonObjectW_stringOf(jResp,L"creditor_bic");
creditor_iban = CkJsonObjectW_stringOf(jResp,L"creditor_iban");
creditor_name = CkJsonObjectW_stringOf(jResp,L"creditor_name");
debitor_bic = CkJsonObjectW_stringOf(jResp,L"debitor_bic");
debitor_address_line_1 = CkJsonObjectW_stringOf(jResp,L"debitor_address_line_1");
debitor_address_line2 = CkJsonObjectW_stringOf(jResp,L"debitor_address_line2");
debitor_country = CkJsonObjectW_stringOf(jResp,L"debitor_country");
export_at = CkJsonObjectW_stringOf(jResp,L"export_at");
export_error = CkJsonObjectW_stringOf(jResp,L"export_error");
id = CkJsonObjectW_stringOf(jResp,L"id");
remittance_information = CkJsonObjectW_stringOf(jResp,L"remittance_information");
requested_at = CkJsonObjectW_stringOf(jResp,L"requested_at");
updated_at = CkJsonObjectW_stringOf(jResp,L"updated_at");
v_type = CkJsonObjectW_stringOf(jResp,L"type");
CkHttpW_Dispose(http);
CkJsonObjectW_Dispose(json);
CkStringBuilderW_Dispose(sbRequestBody);
CkStringBuilderW_Dispose(sbResponseBody);
CkJsonObjectW_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": ""
}
]
}
