{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/v:version/mandates.json","auth":"required","method":"post","examples":{"codes":[{"language":"json","code":"{\n \"fb_person_id\":501,\n \"mandate_status\":\"active\",\n \"signature_date\":\"2018-03-01\",\n \"last_usage_date\":\"\",\n \"transaction_type\":\"one-off\",\n \"bank_account_owner\":\"John Doe\",\n \"bank_iban\":\"DE80440100460123456789\",\n \"bank_bic\":\"PBNKDEFF\",\n \"info\":\"This is just an API test\",\n \"origin\":\"other\",\n \"sent_by\":\"email\",\n \"sent_date\":\"2018-03-23\"\n}"}]},"settings":"","results":{"codes":[{"status":201,"language":"json","code":"{\n \"id\":726,\n \"fb_person_id\":501,\n \"reference_id\":\"FB-SEPA-0407\",\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\":\"DE80440100460123456789\",\n \"bank_bic\":\"PBNKDEFF\",\n \"creditor_id\":\"DE09ZZZ00000155783\",\n \"creditor_name\":\"International Action\",\n \"creditor_address_details\":\"Dummystreet 12\\n12345 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-24\",\n \"updated_at\":\"2019-04-24 13:41:38\"\n}","name":""}]},"params":[]},"next":{"description":"","pages":[]},"title":"/mandates.json","type":"endpoint","slug":"mandates-create","excerpt":"Creates a new SEPA mandate.","body":"[block:parameters]\n{\n \"data\": {\n \"h-0\": \"Field\",\n \"h-1\": \"Description\",\n \"h-2\": \"Type\",\n \"h-3\": \"Mandatory\",\n \"0-0\": \"reference_id\",\n \"1-0\": \"mandate_status\",\n \"2-0\": \"signature_date\",\n \"3-0\": \"last_usage_date\",\n \"4-0\": \"fb_person_id\",\n \"5-0\": \"transaction_type\",\n \"6-0\": \"bank_account_owner\",\n \"7-0\": \"bank_iban\",\n \"8-0\": \"bank_bic\",\n \"9-0\": \"creditor_id\",\n \"10-0\": \"creditor_name\",\n \"11-0\": \"creditor_address_details\",\n \"12-0\": \"info\",\n \"13-0\": \"origin\",\n \"14-0\": \"sent_by\",\n \"15-0\": \"sent_date\",\n \"0-2\": \"string (35)\",\n \"2-2\": \"date\",\n \"3-2\": \"date\",\n \"4-2\": \"integer\",\n \"6-2\": \"string (150)\",\n \"7-2\": \"string (34)\",\n \"8-2\": \"string (11)\",\n \"9-2\": \"string (35)\",\n \"10-2\": \"string (200)\",\n \"11-2\": \"string (300)\",\n \"12-2\": \"string (5000)\",\n \"5-2\": \"Enum (\\\"one-off\\\", \\\"recurrent\\\")\",\n \"1-2\": \"Enum (\\\"recurrent\\\", \\\"active\\\", \\\"cancelled\\\")\",\n \"13-2\": \"Enum (\\\"paper\\\", \\\"eze\\\", \\\"other\\\")\",\n \"14-2\": \"Enum (\\\"email\\\", \\\"post\\\", \\\"website\\\")\",\n \"15-2\": \"date\",\n \"4-3\": \"yes\",\n \"9-3\": \"yes\",\n \"10-3\": \"yes\",\n \"11-3\": \"yes\",\n \"6-3\": \"yes\",\n \"8-3\": \"yes\",\n \"4-1\": \"ID of a [person](doc:persons-list)\",\n \"0-1\": \"Mandate reference\\n(if empty the FundraisingBox will create an unique reference)\",\n \"1-1\": \"Status of the SEPA mandate\",\n \"2-1\": \"Date of signature\",\n \"3-1\": \"Date when the mandate was recently used\",\n \"5-1\": \"Type of the SEPA mandate\",\n \"6-1\": \"Name of the bank account owner\",\n \"7-1\": \"IBAN\",\n \"8-1\": \"BIC\",\n \"9-1\": \"Creditor ID\",\n \"10-1\": \"Creditor name\",\n \"11-1\": \"Creditor address\",\n \"12-1\": \"An optional internal description\",\n \"13-1\": \"Origin of the SEPA mandate\",\n \"14-1\": \"How the SEPA mandate was sent to the donor\",\n \"15-1\": \"Date when the SEPA mandate was sent to the donor\"\n },\n \"cols\": 4,\n \"rows\": 16\n}\n[/block]\n\n[block:callout]\n{\n \"type\": \"danger\",\n \"title\": \"SEPA configuration\",\n \"body\": \"To create SEPA mandates you have to specify your creditor id, IBAN, etc. in your FundraisingBox!\"\n}\n[/block]","updates":[],"order":11,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5cc04c163186000014865a34","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-24T11:44:22.738Z","__v":0,"parentDoc":null}
post/mandates.json
Creates a new SEPA mandate.
Definition
{{ api_url }}{{ page_api_url }}