{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/recurrings/:id.xml","auth":"required","examples":{"codes":[]},"method":"get","params":[{"name":"id","type":"int","default":"","desc":"Recurring ID","required":true,"in":"path","ref":"","_id":"571f9a30ee9c2124004b3e16"}],"results":{"codes":[{"language":"xml","status":200,"name":"","code":"<fb_recurring_payment>\n   <id type=\"integer\">1234</id>\n   <transaction_id>FB-T-9876</transaction_id>\n   <fb_person_id type=\"integer\">123456</fb_person_id>\n   <fb_payment_form_configuration_id type=\"integer\">1234</fb_payment_form_configuration_id>\n   <fb_source_id type=\"integer\">5</fb_source_id>\n   <source_name>\n      <![CDATA[...]]>\n   </source_name>\n   <source_promotion_code> // OPTIONAL\n      <![CDATA[...]]>\n   </source_promotion_code>\n   <fb_project_id type=\"integer\">4</fb_project_id>\n   <project_promotion_code> // OPTIONAL\n      <![CDATA[...]]>\n   </project_promotion_code>\n   <fb_type_id type=\"integer\">2</fb_type_id>\n   <type_promotion_code> // OPTIONAL\n      <![CDATA[...]]>\n   </type_promotion_code>\n   <type>recurring_donation</type>\n   <amount>5</amount>\n   <currency>EUR</currency>\n   <interval>1</interval>\n   <start_date type=\"datetime\">2012-04-26</start_date>\n   <next_payment_date type=\"datetime\">2012-05-26</next_payment_date>\n   <end_date type=\"datetime\"/>\n   <receipt_status>receipt_end_of_year</receipt_status>\n   <fb_person_bank_account_id type=\"integer\">12345</fb_person_bank_account_id> // OPTIONAL\n   <fb_sepa_mandate_id type=\"integer\">12345</fb_sepa_mandate_id> // OPTIONAL\n   <meta_info /> // OPTIONAL see General > Meta Info\n   <fb_custom_fields> // OPTIONAL\n    <fb_custom_field>\n      <id type=\"integer\">123</id>\n      <name>\n        <![CDATA[...]]>\n      </name>\n      <value>\n        <![CDATA[...]]>\n      </value>\n    </fb_custom_field>\n    <fb_custom_field>\n      <id type=\"integer\">124</id>\n      <name>\n        <![CDATA[...]]>\n      </name>\n      <value>\n        <![CDATA[...]]>\n      </value>\n    </fb_custom_field>\n    ...\n   </fb_custom_fields>\n   <created_at type=\"datetime\">2012-03-26 08:22:36</created_at>\n   <updated_at type=\"datetime\">2012-03-26 07:22:36</updated_at>\n</fb_recurring_payment>"}]},"settings":""},"next":{"description":"","pages":[]},"title":"/recurrings/:id.xml","type":"endpoint","slug":"recurringsidxml","excerpt":"Returns a single recurring payment.","body":"","updates":[],"order":16,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"571f9a30ee9c2124004b3e15","__v":2,"createdAt":"2016-04-26T16:41:20.905Z","parentDoc":null,"githubsync":"","project":"571f5e8cd8667f0e00a3c498","editedParams":true,"category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"XML-REST-API (API-Package)","slug":"rest-api","order":9,"from_sync":false,"reference":true,"_id":"571f7fb0ac2a080e0014c661","createdAt":"2016-04-26T14:48:16.712Z","__v":1,"project":"571f5e8cd8667f0e00a3c498","version":"571f5e8cd8667f0e00a3c49b"},"editedParams2":true,"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"}}

get/recurrings/:id.xml

Returns a single recurring payment.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

id:
required
integer
Recurring ID

Result Format


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 }}