Chilkat Online Tools

Ruby / easybill REST API / Fetch SEPA payment

Back to Collection Items

require 'chilkat'

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

http = Chilkat::CkHttp.new()

http.SetRequestHeader("Authorization","{{apiKey}}")
http.SetRequestHeader("Accept","application/json")

sbResponseBody = Chilkat::CkStringBuilder.new()
success = http.QuickGetSb("https://api.easybill.de/rest/v1/sepa-payments/:id",sbResponseBody)
if (success == false)
    print http.lastErrorText() + "\n";
    exit
end

jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(false)

print "Response Body:" + "\n";
print jResp.emit() + "\n";

respStatusCode = http.get_LastStatus()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
    print "Response Header:" + "\n";
    print http.lastHeader() + "\n";
    print "Failed." + "\n";
    exit
end

# 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 GET
	-H "Authorization: {{apiKey}}"
	-H "Accept: application/json"
https://api.easybill.de/rest/v1/sepa-payments/:id

Postman Collection Item JSON

{
  "name": "Fetch SEPA payment",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/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": "GET",
        "header": [
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "Authorization",
            "value": "<API Key>"
          }
        ],
        "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": "Not found",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "Authorization",
            "value": "<API Key>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/sepa-payments/:id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "sepa-payments",
            ":id"
          ],
          "variable": [
            {
              "key": "id"
            }
          ]
        }
      },
      "status": "Not Found",
      "code": 404,
      "_postman_previewlanguage": "text",
      "header": [
      ],
      "cookie": [
      ],
      "body": ""
    },
    {
      "name": "Too Many Requests",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "Authorization",
            "value": "<API Key>"
          }
        ],
        "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": ""
    }
  ]
}