Back to Collection Items
func chilkatTest() {
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
let http = CkoHttp()
var success: Bool
// 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"
// }
let json = CkoJsonObject()
json.UpdateString("document_id", value: "<long>")
json.UpdateString("debitor_name", value: "<string>")
json.UpdateString("debitor_iban", value: "<string>")
json.UpdateString("mandate_id", value: "<string>")
json.UpdateString("mandate_date_of_signature", value: "<date>")
json.UpdateString("local_instrument", value: "COR1")
json.UpdateString("sequence_type", value: "FRST")
json.UpdateString("amount", value: "<integer>")
json.UpdateString("reference", value: "<string>")
json.UpdateString("created_at", value: "<dateTime>")
json.UpdateNull("creditor_bic")
json.UpdateString("creditor_iban", value: "<string>")
json.UpdateString("creditor_name", value: "<string>")
json.UpdateNull("debitor_bic")
json.UpdateString("debitor_address_line_1", value: "<string>")
json.UpdateString("debitor_address_line2", value: "<string>")
json.UpdateString("debitor_country", value: "<string>")
json.UpdateNull("export_at")
json.UpdateString("export_error", value: "<string>")
json.UpdateString("id", value: "<long>")
json.UpdateNull("remittance_information")
json.UpdateString("requested_at", value: "Today's date")
json.UpdateString("updated_at", value: "<string>")
json.UpdateString("type", value: "DEBIT")
http.SetRequestHeader("Content-Type", value: "application/json")
http.SetRequestHeader("Authorization", value: "{{apiKey}}")
http.SetRequestHeader("Accept", value: "application/json")
let sbRequestBody = CkoStringBuilder()
json.EmitSb(sbRequestBody)
var resp: CkoHttpResponse? = http.PTextSb("PUT", url: "https://api.easybill.de/rest/v1/sepa-payments/:id", textData: sbRequestBody, charset: "utf-8", contentType: "application/json", md5: false, gzip: false)
if http.LastMethodSuccess == false {
print("\(http.LastErrorText)")
return
}
let sbResponseBody = CkoStringBuilder()
resp!.GetBodySb(sbResponseBody)
let jResp = CkoJsonObject()
jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = false
print("Response Body:")
print("\(jResp.Emit())")
var respStatusCode: Int = resp!.StatusCode.intValue
print("Response Status Code = \(respStatusCode)")
if respStatusCode >= 400 {
print("Response Header:")
print("\(resp!.Header)")
print("Failed.")
resp = nil
return
}
resp = nil
// 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
var document_id: String? = jResp.StringOf("document_id")
var debitor_name: String? = jResp.StringOf("debitor_name")
var debitor_iban: String? = jResp.StringOf("debitor_iban")
var mandate_id: String? = jResp.StringOf("mandate_id")
var mandate_date_of_signature: String? = jResp.StringOf("mandate_date_of_signature")
var local_instrument: String? = jResp.StringOf("local_instrument")
var sequence_type: String? = jResp.StringOf("sequence_type")
var amount: String? = jResp.StringOf("amount")
var reference: String? = jResp.StringOf("reference")
var created_at: String? = jResp.StringOf("created_at")
var creditor_bic: String? = jResp.StringOf("creditor_bic")
var creditor_iban: String? = jResp.StringOf("creditor_iban")
var creditor_name: String? = jResp.StringOf("creditor_name")
var debitor_bic: String? = jResp.StringOf("debitor_bic")
var debitor_address_line_1: String? = jResp.StringOf("debitor_address_line_1")
var debitor_address_line2: String? = jResp.StringOf("debitor_address_line2")
var debitor_country: String? = jResp.StringOf("debitor_country")
var export_at: String? = jResp.StringOf("export_at")
var export_error: String? = jResp.StringOf("export_error")
var id: String? = jResp.StringOf("id")
var remittance_information: String? = jResp.StringOf("remittance_information")
var requested_at: String? = jResp.StringOf("requested_at")
var updated_at: String? = jResp.StringOf("updated_at")
var v_type: String? = jResp.StringOf("type")
}
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": ""
}
]
}
