PowerBuilder / easybill REST API / Update SEPA payment
Back to Collection Items
integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_Json
oleobject loo_SbRequestBody
oleobject loo_Resp
oleobject loo_SbResponseBody
oleobject loo_JResp
integer li_RespStatusCode
string ls_Document_id
string ls_Debitor_name
string ls_Debitor_iban
string ls_Mandate_id
string ls_Mandate_date_of_signature
string ls_Local_instrument
string ls_Sequence_type
string ls_Amount
string ls_Reference
string ls_Created_at
string ls_Creditor_bic
string ls_Creditor_iban
string ls_Creditor_name
string ls_Debitor_bic
string ls_Debitor_address_line_1
string ls_Debitor_address_line2
string ls_Debitor_country
string ls_Export_at
string ls_Export_error
string ls_Id
string ls_Remittance_information
string ls_Requested_at
string ls_Updated_at
string ls_V_type
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loo_Http = create oleobject
// Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
li_rc = loo_Http.ConnectToNewObject("Chilkat.Http")
if li_rc < 0 then
destroy loo_Http
MessageBox("Error","Connecting to COM object failed")
return
end if
// 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"
// }
loo_Json = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_Json.ConnectToNewObject("Chilkat.JsonObject")
loo_Json.UpdateString("document_id","<long>")
loo_Json.UpdateString("debitor_name","<string>")
loo_Json.UpdateString("debitor_iban","<string>")
loo_Json.UpdateString("mandate_id","<string>")
loo_Json.UpdateString("mandate_date_of_signature","<date>")
loo_Json.UpdateString("local_instrument","COR1")
loo_Json.UpdateString("sequence_type","FRST")
loo_Json.UpdateString("amount","<integer>")
loo_Json.UpdateString("reference","<string>")
loo_Json.UpdateString("created_at","<dateTime>")
loo_Json.UpdateNull("creditor_bic")
loo_Json.UpdateString("creditor_iban","<string>")
loo_Json.UpdateString("creditor_name","<string>")
loo_Json.UpdateNull("debitor_bic")
loo_Json.UpdateString("debitor_address_line_1","<string>")
loo_Json.UpdateString("debitor_address_line2","<string>")
loo_Json.UpdateString("debitor_country","<string>")
loo_Json.UpdateNull("export_at")
loo_Json.UpdateString("export_error","<string>")
loo_Json.UpdateString("id","<long>")
loo_Json.UpdateNull("remittance_information")
loo_Json.UpdateString("requested_at","Today's date")
loo_Json.UpdateString("updated_at","<string>")
loo_Json.UpdateString("type","DEBIT")
loo_Http.SetRequestHeader("Content-Type","application/json")
loo_Http.SetRequestHeader("Authorization","{{apiKey}}")
loo_Http.SetRequestHeader("Accept","application/json")
loo_SbRequestBody = create oleobject
// Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
li_rc = loo_SbRequestBody.ConnectToNewObject("Chilkat.StringBuilder")
loo_Json.EmitSb(loo_SbRequestBody)
loo_Resp = loo_Http.PTextSb("PUT","https://api.easybill.de/rest/v1/sepa-payments/:id",loo_SbRequestBody,"utf-8","application/json",0,0)
if loo_Http.LastMethodSuccess = 0 then
Write-Debug loo_Http.LastErrorText
destroy loo_Http
destroy loo_Json
destroy loo_SbRequestBody
return
end if
loo_SbResponseBody = create oleobject
// Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
li_rc = loo_SbResponseBody.ConnectToNewObject("Chilkat.StringBuilder")
loo_Resp.GetBodySb(loo_SbResponseBody)
loo_JResp = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_JResp.ConnectToNewObject("Chilkat.JsonObject")
loo_JResp.LoadSb(loo_SbResponseBody)
loo_JResp.EmitCompact = 0
Write-Debug "Response Body:"
Write-Debug loo_JResp.Emit()
li_RespStatusCode = loo_Resp.StatusCode
Write-Debug "Response Status Code = " + string(li_RespStatusCode)
if li_RespStatusCode >= 400 then
Write-Debug "Response Header:"
Write-Debug loo_Resp.Header
Write-Debug "Failed."
destroy loo_Resp
destroy loo_Http
destroy loo_Json
destroy loo_SbRequestBody
destroy loo_SbResponseBody
destroy loo_JResp
return
end if
destroy loo_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
ls_Document_id = loo_JResp.StringOf("document_id")
ls_Debitor_name = loo_JResp.StringOf("debitor_name")
ls_Debitor_iban = loo_JResp.StringOf("debitor_iban")
ls_Mandate_id = loo_JResp.StringOf("mandate_id")
ls_Mandate_date_of_signature = loo_JResp.StringOf("mandate_date_of_signature")
ls_Local_instrument = loo_JResp.StringOf("local_instrument")
ls_Sequence_type = loo_JResp.StringOf("sequence_type")
ls_Amount = loo_JResp.StringOf("amount")
ls_Reference = loo_JResp.StringOf("reference")
ls_Created_at = loo_JResp.StringOf("created_at")
ls_Creditor_bic = loo_JResp.StringOf("creditor_bic")
ls_Creditor_iban = loo_JResp.StringOf("creditor_iban")
ls_Creditor_name = loo_JResp.StringOf("creditor_name")
ls_Debitor_bic = loo_JResp.StringOf("debitor_bic")
ls_Debitor_address_line_1 = loo_JResp.StringOf("debitor_address_line_1")
ls_Debitor_address_line2 = loo_JResp.StringOf("debitor_address_line2")
ls_Debitor_country = loo_JResp.StringOf("debitor_country")
ls_Export_at = loo_JResp.StringOf("export_at")
ls_Export_error = loo_JResp.StringOf("export_error")
ls_Id = loo_JResp.StringOf("id")
ls_Remittance_information = loo_JResp.StringOf("remittance_information")
ls_Requested_at = loo_JResp.StringOf("requested_at")
ls_Updated_at = loo_JResp.StringOf("updated_at")
ls_V_type = loo_JResp.StringOf("type")
destroy loo_Http
destroy loo_Json
destroy loo_SbRequestBody
destroy loo_SbResponseBody
destroy loo_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": ""
}
]
}
