Back to Collection Items
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess
; 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"
; }
$oJson = ObjCreate("Chilkat.JsonObject")
$oJson.UpdateString("document_id","<long>")
$oJson.UpdateString("debitor_name","<string>")
$oJson.UpdateString("debitor_iban","<string>")
$oJson.UpdateString("mandate_id","<string>")
$oJson.UpdateString("mandate_date_of_signature","<date>")
$oJson.UpdateString("local_instrument","COR1")
$oJson.UpdateString("sequence_type","FRST")
$oJson.UpdateString("amount","<integer>")
$oJson.UpdateString("reference","<string>")
$oJson.UpdateString("created_at","<dateTime>")
$oJson.UpdateNull("creditor_bic")
$oJson.UpdateString("creditor_iban","<string>")
$oJson.UpdateString("creditor_name","<string>")
$oJson.UpdateNull("debitor_bic")
$oJson.UpdateString("debitor_address_line_1","<string>")
$oJson.UpdateString("debitor_address_line2","<string>")
$oJson.UpdateString("debitor_country","<string>")
$oJson.UpdateNull("export_at")
$oJson.UpdateString("export_error","<string>")
$oJson.UpdateString("id","<long>")
$oJson.UpdateNull("remittance_information")
$oJson.UpdateString("requested_at","Today's date")
$oJson.UpdateString("updated_at","<string>")
$oJson.UpdateString("type","DEBIT")
$oHttp.SetRequestHeader "Content-Type","application/json"
$oHttp.SetRequestHeader "Authorization","{{apiKey}}"
$oHttp.SetRequestHeader "Accept","application/json"
$oSbRequestBody = ObjCreate("Chilkat.StringBuilder")
$oJson.EmitSb($oSbRequestBody)
Local $oResp = $oHttp.PTextSb("PUT","https://api.easybill.de/rest/v1/sepa-payments/:id",$oSbRequestBody,"utf-8","application/json",False,False)
If ($oHttp.LastMethodSuccess = False) Then
ConsoleWrite($oHttp.LastErrorText & @CRLF)
Exit
EndIf
$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$oResp.GetBodySb($oSbResponseBody)
$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False
ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)
Local $iRespStatusCode = $oResp.StatusCode
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
ConsoleWrite("Response Header:" & @CRLF)
ConsoleWrite($oResp.Header & @CRLF)
ConsoleWrite("Failed." & @CRLF)
Exit
EndIf
; 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
Local $sDocument_id = $oJResp.StringOf("document_id")
Local $sDebitor_name = $oJResp.StringOf("debitor_name")
Local $sDebitor_iban = $oJResp.StringOf("debitor_iban")
Local $sMandate_id = $oJResp.StringOf("mandate_id")
Local $sMandate_date_of_signature = $oJResp.StringOf("mandate_date_of_signature")
Local $sLocal_instrument = $oJResp.StringOf("local_instrument")
Local $sequence_type = $oJResp.StringOf("sequence_type")
Local $sAmount = $oJResp.StringOf("amount")
Local $sReference = $oJResp.StringOf("reference")
Local $sCreated_at = $oJResp.StringOf("created_at")
Local $sCreditor_bic = $oJResp.StringOf("creditor_bic")
Local $sCreditor_iban = $oJResp.StringOf("creditor_iban")
Local $sCreditor_name = $oJResp.StringOf("creditor_name")
Local $sDebitor_bic = $oJResp.StringOf("debitor_bic")
Local $sDebitor_address_line_1 = $oJResp.StringOf("debitor_address_line_1")
Local $sDebitor_address_line2 = $oJResp.StringOf("debitor_address_line2")
Local $sDebitor_country = $oJResp.StringOf("debitor_country")
Local $sExport_at = $oJResp.StringOf("export_at")
Local $sExport_error = $oJResp.StringOf("export_error")
Local $sId = $oJResp.StringOf("id")
Local $sRemittance_information = $oJResp.StringOf("remittance_information")
Local $sRequested_at = $oJResp.StringOf("requested_at")
Local $sUpdated_at = $oJResp.StringOf("updated_at")
Local $sV_type = $oJResp.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": ""
}
]
}
