{"_id":"57d158a21227b40e004490a3","version":{"_id":"571f5e8cd8667f0e00a3c49b","hasDoc":true,"__v":13,"hasReference":true,"project":"571f5e8cd8667f0e00a3c498","createdAt":"2016-04-26T12:26:52.312Z","releaseDate":"2016-04-26T12:26:52.312Z","categories":["571f5e8cd8667f0e00a3c49c","571f73cfcb4baa0e00d13a80","571f7451cb4baa0e00d13a88","571f7d2720695f3400f38797","571f7fb0ac2a080e0014c661","571f884be54f2d0e003ebb0a","572200c9ecb38d0e00d80ebd","572c301e7c8eff0e00aaa174","57df91b2c6348d0e0020c452","57e104db9ff1e21900a721ab","57fd04caeaa77f19008b8202","5899c7113514ce0f0014da84","5cbeda4b862d090013abd413"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1"},"__v":5,"githubsync":"","user":"5720ba18c669e80e00c35051","category":{"_id":"571f7fb0ac2a080e0014c661","__v":0,"project":"571f5e8cd8667f0e00a3c498","version":"571f5e8cd8667f0e00a3c49b","sync":{"url":"","isSync":false},"reference":true,"createdAt":"2016-04-26T14:48:16.712Z","from_sync":false,"order":7,"slug":"rest-api","title":"REST-API (XML)"},"parentDoc":null,"project":"571f5e8cd8667f0e00a3c498","updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-09-08T12:25:06.281Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"method":"get","results":{"codes":[{"status":200,"language":"xml","code":"<fb_transactions>\n\t<fb_transaction>\n    <token>7h1515ju574n3x4mpl370k3n</token>\n    <is_test>0</is_test>\n    <parent_url>https://example.com/donation</parent_url>\n    <transaction_id>FB-T-1234567</transaction_id>\n    <fb_payment_form_configuration_id type=\"integer\">1234</fb_payment_form_configuration_id>\n    <fb_source_id type=\"integer\">3</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\"/>\n    <project_promotion_code> // OPTIONAL\n      <![CDATA[...]]>\n    </project_promotion_code>\n    <fb_type_id type=\"integer\">8</fb_type_id>\n    <type_promotion_code> // OPTIONAL\n      <![CDATA[...]]>\n    </type_promotion_code>\n    <amount>12.34</amount>\n    <currency>EUR</currency>\n    <interval type=\"integer\">0</interval>\n    <fb_donation_id type=\"integer\">12345</fb_donation_id>\n    <by_recurring>0</by_recurring>\n    <fb_recurring_payment_id type=\"integer\"></fb_recurring_payment_id>\n    <meta_info>\n      ...\n    </meta_infos>\n    <receipt_status>receipt_end_of_year</receipt_status>\n    <public_name>\n      <![CDATA[...]]>\n    </public_name>\n    <public_message>\n      <![CDATA[...]]>\n    </public_message>\n    <fb_fundraising_page_id type=\"integer\"></fb_fundraising_page_id>\n    <fb_donation_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_donation_custom_fields>\n    // person name: if company is donor, only company_name exists\n    // otherwise salutation, title, first_name, last_name\n    <salutation>Mrs.</salutation> // OPTIONAL\n    <title> // OPTIONAL\n      <![CDATA[...]]>\n    </title>\n    <first_name> // OPTIONAL\n      <![CDATA[Beate]]>\n    </first_name>\n    <last_name> // OPTIONAL\n      <![CDATA[Beispiel]]>\n    </last_name>\n    <company_name> // OPTIONAL\n      <![CDATA[...]]>\n    </company_name>\n    <birthday>1978-05-22</birthday>\n    <wants_newsletter>1</wants_newsletter>\n    <email><![CDATA[john.doe:::at:::example.com]]></email>\n    <phone>\n      <![CDATA[0123 456789]]>\n    </phone>\n    <address>\n      <![CDATA[Bspstr.2]]>\n    </address>\n    <post_code>\n      <![CDATA[12345]]>\n    </post_code>\n    <city>\n      <![CDATA[Bspstadt]]>\n    </city>\n    <country>DE</country>\n    <bank_account_owner>\n      <![CDATA[Beate Beispiel]]>\n    </bank_account_owner>\n    <bank_number>\n      <![CDATA[]]>\n    </bank_number>\n    <bank_account_number>\n      <![CDATA[]]>\n    </bank_account_number>\n    <bank_iban>\n      <![CDATA[DE12345...]]>\n    </bank_iban>\n    <bank_bic>\n      <![CDATA[TESTDE77...]]>\n    </bank_bic>\n    <bank_name>\n      <![CDATA[...]]>\n    </bank_name>\n    <bank_country>DE</bank_country>\n    <meta_info /> // OPTIONAL see General > Meta Info\n    <mandate_reference_id> // OPTIONAL\n      <![CDATA[FB-SEPA-12345]]>\n    </mandate_reference_id>\n    <mandate_status>active</mandate_status> // OPTIONAL\n    <mandate_signature_date type=\"date\">2015-03-12</mandate_signature_date> // OPTIONAL\n    <mandate_last_usage_date type=\"date\"></mandate_last_usage_date> // OPTIONAL\n    <mandate_transaction_type>one-off</mandate_transaction_type> // OPTIONAL\n    <mandate_origin>other</mandate_origin> // OPTIONAL\n    <fb_person_custom_fields> // OPTIONAL\n      <fb_custom_field>\n        <id type=\"integer\">987</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\">988</id>\n        <name>\n          <![CDATA[...]]>\n        </name>\n        <value>\n          <![CDATA[...]]>\n        </value>\n      </fb_custom_field>\n      ...\n    </fb_person_custom_fields>\n    <updated_at type=\"datetime\">2016-09-20 09:37:25</updated_at>\n    <created_at type=\"datetime\">2016-09-20 09:37:11</created_at>\n    <received_at type=\"datetime\">2016-09-20 09:37:11</received_at>\n    <status>confirmed</status>\n    <ip>192.0.2.0</ip>\n  </fb_transaction>\n  <fb_transaction>...</fb_transaction>\n  ...\n</fb_transactions>","name":""}]},"settings":"","auth":"required","params":[{"_id":"57ee23213b369f0e00469c4b","ref":"","in":"query","required":false,"desc":"optional","default":"","type":"int","name":"page"},{"_id":"57ee2640db415b0e00294205","ref":"","in":"query","required":false,"desc":"optional","default":"","type":"array_string","name":"criteria"}],"url":"/transactions.xml"},"isReference":true,"order":21,"body":"[block:callout]\n{\n  \"type\": \"danger\",\n  \"title\": \"Important: transactions vs. donations\",\n  \"body\": \"If you would like to retrieve donation data please use donations.xml! This transactions.xml is only suitable for some special cases if you need data immediately after the donation.\\n\\nWhile a transaction offers raw data from the donation form donations have a higher data quality and are available for manual created donations as well.\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"Maximum is 100 entries, use the page parameter to get the next results.\\n(with pagination: /transactions.xml?page={page_number})\",\n  \"title\": \"Pagination\"\n}\n[/block]\n**List by criterias**\nGET /transactions.xml?criteria[amount_min]={value}&page={page_number}\n\nReturns a collection of transactions that fits to a given criteria array.\nMaximum is 100 entries, use the page parameter to get the next results.\n\nThese criteria are currently available:\n\n    token\n    amount_min\n    amount_max\n    date_min\n    date_max\n    fb_type_id\n    fb_source_id\n    fb_payment_form_configuration_id\n    status\n    recurring\n    meta_info\n    \nExample: You can find a transaction by its token with the following request:\nGET /transactions.xml?criteria[token]={value}\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"If no transaction with these criteria exist, an empty transaction container will be returned.\",\n  \"title\": \"Empty result\"\n}\n[/block]","excerpt":"Returns a collection of transactions.","slug":"transactionsxml","type":"endpoint","title":"/transactions.xml"}