Swift3 / easybill REST API / Fetch SEPA payments list
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
let queryParams = CkoJsonObject()!
queryParams.update("limit", value: "<integer>")
queryParams.update("page", value: "<integer>")
queryParams.update("document_id", value: "<string>")
http.setRequestHeader("Authorization", value: "{{apiKey}}")
http.setRequestHeader("Accept", value: "application/json")
var resp: CkoHttpResponse? = http.quickRequestParams("GET", url: "https://api.easybill.de/rest/v1/sepa-payments", json: queryParams)
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)
// {
// "page": "<integer>",
// "pages": "<integer>",
// "limit": "<integer>",
// "total": "<integer>",
// "items": [
// {
// "document_id": "<long>",
// "debitor_name": "<string>",
// "debitor_iban": "<string>",
// "mandate_id": "<string>",
// "mandate_date_of_signature": "<date>",
// "local_instrument": "B2B",
// "sequence_type": "RCUR",
// "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"
// },
// {
// "document_id": "<long>",
// "debitor_name": "<string>",
// "debitor_iban": "<string>",
// "mandate_id": "<string>",
// "mandate_date_of_signature": "<date>",
// "local_instrument": "COR1",
// "sequence_type": "FNAL",
// "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?
var debitor_name: String?
var debitor_iban: String?
var mandate_id: String?
var mandate_date_of_signature: String?
var local_instrument: String?
var sequence_type: String?
var amount: String?
var reference: String?
var created_at: String?
var creditor_bic: String?
var creditor_iban: String?
var creditor_name: String?
var debitor_bic: String?
var debitor_address_line_1: String?
var debitor_address_line2: String?
var debitor_country: String?
var export_at: String?
var export_error: String?
var id: String?
var remittance_information: String?
var requested_at: String?
var updated_at: String?
var v_type: String?
var page: String? = jResp.string(of: "page")
var pages: String? = jResp.string(of: "pages")
var limit: String? = jResp.string(of: "limit")
var total: String? = jResp.string(of: "total")
var i: Int = 0
var count_i: Int = jResp.size(ofArray: "items").intValue
while i < count_i {
jResp.i = i
document_id = jResp.string(of: "items[i].document_id")
debitor_name = jResp.string(of: "items[i].debitor_name")
debitor_iban = jResp.string(of: "items[i].debitor_iban")
mandate_id = jResp.string(of: "items[i].mandate_id")
mandate_date_of_signature = jResp.string(of: "items[i].mandate_date_of_signature")
local_instrument = jResp.string(of: "items[i].local_instrument")
sequence_type = jResp.string(of: "items[i].sequence_type")
amount = jResp.string(of: "items[i].amount")
reference = jResp.string(of: "items[i].reference")
created_at = jResp.string(of: "items[i].created_at")
creditor_bic = jResp.string(of: "items[i].creditor_bic")
creditor_iban = jResp.string(of: "items[i].creditor_iban")
creditor_name = jResp.string(of: "items[i].creditor_name")
debitor_bic = jResp.string(of: "items[i].debitor_bic")
debitor_address_line_1 = jResp.string(of: "items[i].debitor_address_line_1")
debitor_address_line2 = jResp.string(of: "items[i].debitor_address_line2")
debitor_country = jResp.string(of: "items[i].debitor_country")
export_at = jResp.string(of: "items[i].export_at")
export_error = jResp.string(of: "items[i].export_error")
id = jResp.string(of: "items[i].id")
remittance_information = jResp.string(of: "items[i].remittance_information")
requested_at = jResp.string(of: "items[i].requested_at")
updated_at = jResp.string(of: "items[i].updated_at")
v_type = jResp.string(of: "items[i].type")
i = i + 1
}
}
Curl Command
curl -G -d "limit=%3Cinteger%3E"
-d "page=%3Cinteger%3E"
-d "document_id=%3Cstring%3E"
-H "Authorization: {{apiKey}}"
-H "Accept: application/json"
https://api.easybill.de/rest/v1/sepa-payments
Postman Collection Item JSON
{
"name": "Fetch SEPA payments list",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/sepa-payments?limit=<integer>&page=<integer>&document_id=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"sepa-payments"
],
"query": [
{
"key": "limit",
"value": "<integer>",
"description": "Limited the result. Default is 100. Maximum can be 1000."
},
{
"key": "page",
"value": "<integer>",
"description": "Set current Page. Default is 1."
},
{
"key": "document_id",
"value": "<string>",
"description": "Filter SEPA payment by document_id. You can add multiple ids separate by comma like id,id,id."
}
]
}
},
"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?limit=<integer>&page=<integer>&document_id=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"sepa-payments"
],
"query": [
{
"key": "limit",
"value": "<integer>",
"description": "Limited the result. Default is 100. Maximum can be 1000."
},
{
"key": "page",
"value": "<integer>",
"description": "Set current Page. Default is 1."
},
{
"key": "document_id",
"value": "<string>",
"description": "Filter SEPA payment by document_id. You can add multiple ids separate by comma like id,id,id."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"page\": \"<integer>\",\n \"pages\": \"<integer>\",\n \"limit\": \"<integer>\",\n \"total\": \"<integer>\",\n \"items\": [\n {\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\": \"B2B\",\n \"sequence_type\": \"RCUR\",\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 },\n {\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\": \"FNAL\",\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 }\n ]\n}"
},
{
"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?limit=<integer>&page=<integer>&document_id=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"sepa-payments"
],
"query": [
{
"key": "limit",
"value": "<integer>",
"description": "Limited the result. Default is 100. Maximum can be 1000."
},
{
"key": "page",
"value": "<integer>",
"description": "Set current Page. Default is 1."
},
{
"key": "document_id",
"value": "<string>",
"description": "Filter SEPA payment by document_id. You can add multiple ids separate by comma like id,id,id."
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "text",
"header": [
],
"cookie": [
],
"body": ""
}
]
}
