{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/recurrings.xml","auth":"required","examples":{"codes":[]},"method":"get","params":[],"results":{"codes":[{"status":200,"language":"xml","code":"<fb_recurring_payments>\n <fb_recurring_payment>...</fb_recurring_payment>\n <fb_recurring_payment>...</fb_recurring_payment>\n</fb_recurring_payments>","name":""}]},"settings":""},"next":{"description":"","pages":[]},"title":"/recurrings.xml","type":"endpoint","slug":"recurringsxml","excerpt":"Returns a collection of recurring payments that fits to a given criteria array.","body":"[block:callout]\n{\n \"type\": \"info\",\n \"title\": \"\",\n \"body\": \"Maximum is 100 entries, use the page parameter to get the next results.\"\n}\n[/block]\nGET /recurrings.xml?criteria[amount_min]={value}&page={page_number}\n\nThese criteria are currently available:\n\n show\n type\n amount_min\n amount_max\n start_min\n start_max\n next_min\n next_max\n interval\n fb_project_id\n fb_type_id\n fb_source_id\n fb_payment_form_configuration_id\n fb_person_id\n ids (separated by comma)\n search_id (smart-search id)\n\n\n[block:callout]\n{\n \"type\": \"info\",\n \"body\": \"If no recurring payments with these criteria exist, an empty recurring payment container will be returned.\"\n}\n[/block]","updates":[],"order":15,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"571f9b38ebdbad1700a0c832","parentDoc":null,"project":"571f5e8cd8667f0e00a3c498","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"XML-REST-API (deprecated; API-Package)","slug":"rest-api","order":10,"from_sync":false,"reference":true,"_id":"571f7fb0ac2a080e0014c661","createdAt":"2016-04-26T14:48:16.712Z","__v":1,"project":"571f5e8cd8667f0e00a3c498","version":"571f5e8cd8667f0e00a3c49b"},"createdAt":"2016-04-26T16:45:44.133Z","user":"571f5e46d8e3cf1900762b33","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"},"__v":3,"githubsync":""}
get/recurrings.xml
Returns a collection of recurring payments that fits to a given criteria array.
Definition
{{ api_url }}{{ page_api_url }}