Chilkat Online Tools

Perl / easybill REST API / Update SEPA payment

Back to Collection Items

use chilkat();

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

$http = chilkat::CkHttp->new();

# 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 = chilkat::CkJsonObject->new();
$json->UpdateString("document_id","<long>");
$json->UpdateString("debitor_name","<string>");
$json->UpdateString("debitor_iban","<string>");
$json->UpdateString("mandate_id","<string>");
$json->UpdateString("mandate_date_of_signature","<date>");
$json->UpdateString("local_instrument","COR1");
$json->UpdateString("sequence_type","FRST");
$json->UpdateString("amount","<integer>");
$json->UpdateString("reference","<string>");
$json->UpdateString("created_at","<dateTime>");
$json->UpdateNull("creditor_bic");
$json->UpdateString("creditor_iban","<string>");
$json->UpdateString("creditor_name","<string>");
$json->UpdateNull("debitor_bic");
$json->UpdateString("debitor_address_line_1","<string>");
$json->UpdateString("debitor_address_line2","<string>");
$json->UpdateString("debitor_country","<string>");
$json->UpdateNull("export_at");
$json->UpdateString("export_error","<string>");
$json->UpdateString("id","<long>");
$json->UpdateNull("remittance_information");
$json->UpdateString("requested_at","Today's date");
$json->UpdateString("updated_at","<string>");
$json->UpdateString("type","DEBIT");

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

$sbRequestBody = chilkat::CkStringBuilder->new();
$json->EmitSb($sbRequestBody);

# resp is a HttpResponse
$resp = $http->PTextSb("PUT","https://api.easybill.de/rest/v1/sepa-payments/:id",$sbRequestBody,"utf-8","application/json",0,0);
if ($http->get_LastMethodSuccess() == 0) {
    print $http->lastErrorText() . "\r\n";
    exit;
}

$sbResponseBody = chilkat::CkStringBuilder->new();
$resp->GetBodySb($sbResponseBody);

$jResp = chilkat::CkJsonObject->new();
$jResp->LoadSb($sbResponseBody);
$jResp->put_EmitCompact(0);

print "Response Body:" . "\r\n";
print $jResp->emit() . "\r\n";

$respStatusCode = $resp->get_StatusCode();
print "Response Status Code = " . $respStatusCode . "\r\n";
if ($respStatusCode >= 400) {
    print "Response Header:" . "\r\n";
    print $resp->header() . "\r\n";
    print "Failed." . "\r\n";

    exit;
}

# 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

$document_id = $jResp->stringOf("document_id");
$debitor_name = $jResp->stringOf("debitor_name");
$debitor_iban = $jResp->stringOf("debitor_iban");
$mandate_id = $jResp->stringOf("mandate_id");
$mandate_date_of_signature = $jResp->stringOf("mandate_date_of_signature");
$local_instrument = $jResp->stringOf("local_instrument");
$sequence_type = $jResp->stringOf("sequence_type");
$amount = $jResp->stringOf("amount");
$reference = $jResp->stringOf("reference");
$created_at = $jResp->stringOf("created_at");
$creditor_bic = $jResp->stringOf("creditor_bic");
$creditor_iban = $jResp->stringOf("creditor_iban");
$creditor_name = $jResp->stringOf("creditor_name");
$debitor_bic = $jResp->stringOf("debitor_bic");
$debitor_address_line_1 = $jResp->stringOf("debitor_address_line_1");
$debitor_address_line2 = $jResp->stringOf("debitor_address_line2");
$debitor_country = $jResp->stringOf("debitor_country");
$export_at = $jResp->stringOf("export_at");
$export_error = $jResp->stringOf("export_error");
$id = $jResp->stringOf("id");
$remittance_information = $jResp->stringOf("remittance_information");
$requested_at = $jResp->stringOf("requested_at");
$updated_at = $jResp->stringOf("updated_at");
$v_type = $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": ""
    }
  ]
}