{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/v:version/mandates/:id.json","auth":"required","settings":"","results":{"codes":[{"code":"{\n    \"id\":712,\n    \"fb_person_id\":501,\n    \"reference_id\":\"FB-SEPA-0393\",\n    \"mandate_status\":\"active\",\n    \"signature_date\":\"2018-03-01\",\n    \"last_usage_date\":null,\n    \"transaction_type\":\"one-off\",\n    \"bank_account_owner\":\"John Doe\",\n    \"bank_iban\":\"DE80440100123456789\",\n    \"bank_bic\":\"PBNKDEFF\",\n    \"creditor_id\":\"DE09ZZZ00000155783\",\n    \"creditor_name\":\"International Action\",\n    \"creditor_address_details\":\"Demo street 7, Democity\",\n    \"info\":\"This is just an api test\",\n    \"origin\":\"other\",\n    \"sent_by\":\"email\",\n    \"sent_date\":\"2018-03-23\",\n    \"created_date\":\"2019-04-23\",\n    \"updated_at\":\"2019-04-23 13:55:32\"\n}","name":"","status":200,"language":"json"}]},"method":"get","examples":{"codes":[]},"params":[{"name":"id","type":"int","default":"","desc":"Mandate ID","required":true,"in":"path","ref":"","_id":"571f9c07ebdbad1700a0c838"}]},"next":{"description":"","pages":[]},"title":"/mandates/:id.json","type":"endpoint","slug":"mandates-show","excerpt":"Returns a single SEPA mandate.","body":"Shows a single SEPA mandate with a given ID.\n[block:api-header]\n{\n  \"title\": \"Enum values\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Possible values\",\n    \"0-0\": \"**origin**\",\n    \"2-0\": \"**sent_by**\",\n    \"1-0\": \"**mandate_status**\",\n    \"1-1\": \"pending\\nactive\\ncancelled\",\n    \"2-1\": \"email\\npost\\nwebsite\",\n    \"0-1\": \"paper\\nemandate\\neze\\nother\",\n    \"3-0\": \"**transaction_type**\",\n    \"3-1\": \"one-off\\nrecurrent\"\n  },\n  \"cols\": 2,\n  \"rows\": 4\n}\n[/block]","updates":[],"order":10,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5cbefd8ff5427400244a8ce2","project":"571f5e8cd8667f0e00a3c498","version":{"version":"1","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["571f5e8cd8667f0e00a3c49c","571f73cfcb4baa0e00d13a80","571f7451cb4baa0e00d13a88","571f7d2720695f3400f38797","571f7fb0ac2a080e0014c661","571f884be54f2d0e003ebb0a","572200c9ecb38d0e00d80ebd","572c301e7c8eff0e00aaa174","57df91b2c6348d0e0020c452","57e104db9ff1e21900a721ab","57fd04caeaa77f19008b8202","5899c7113514ce0f0014da84","5cbeda4b862d090013abd413","5e60d6278f8b380072f0b1e3"],"_id":"571f5e8cd8667f0e00a3c49b","hasDoc":true,"releaseDate":"2016-04-26T12:26:52.312Z","__v":14,"hasReference":true,"createdAt":"2016-04-26T12:26:52.312Z","project":"571f5e8cd8667f0e00a3c498"},"category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"JSON-REST-API (API-Package)","slug":"rest-api-json","order":9,"from_sync":false,"reference":false,"_id":"5cbeda4b862d090013abd413","project":"571f5e8cd8667f0e00a3c498","version":"571f5e8cd8667f0e00a3c49b","createdAt":"2019-04-23T09:26:35.210Z","__v":1},"user":"5720ba18c669e80e00c35051","createdAt":"2019-04-23T11:57:03.711Z","__v":9,"parentDoc":null}

get/mandates/:id.json

Returns a single SEPA mandate.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

id:
required
integer
Mandate ID

Result Format


Documentation

Shows a single SEPA mandate with a given ID. [block:api-header] { "title": "Enum values" } [/block] [block:parameters] { "data": { "h-0": "Field", "h-1": "Possible values", "0-0": "**origin**", "2-0": "**sent_by**", "1-0": "**mandate_status**", "1-1": "pending\nactive\ncancelled", "2-1": "email\npost\nwebsite", "0-1": "paper\nemandate\neze\nother", "3-0": "**transaction_type**", "3-1": "one-off\nrecurrent" }, "cols": 2, "rows": 4 } [/block]

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}