{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/payouts.xml","auth":"required","results":{"codes":[{"status":200,"language":"xml","code":"<fb_payouts>\n   <fb_payout>...</fb_payout>\n   <fb_payout>...</fb_payout>\n   ...\n</fb_payout>","name":""}]},"method":"get","examples":{"codes":[]},"settings":"","params":[]},"next":{"description":"","pages":[]},"title":"/payouts.xml (BETA)","type":"endpoint","slug":"payoutsxml","excerpt":"Returns a collection of payouts.","body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"Maximum is 100 entries, use the page parameter to get the next results.\\n\\n(with pagination: /payouts.xml?page={page_number})\"\n}\n[/block]\nList by criterias\nGET /payouts.xml?criteria[amount_min]={value}&criteria[amount_max]={value}&page={page_number}\n\nReturns a collection of payouts 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    amount_min\n    amount_max\n    created_time_min\n    created_time_max\n    external_payout_id\n    fb_type_id\n    id_min\n    id_max\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"If no payouts with these criteria exist, an empty payouts container will be returned.\"\n}\n[/block]","updates":[],"order":9,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5c9264b66275de001a6ca9ad","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":"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"},"user":"5720c075db52d01700f5d1e4","createdAt":"2019-03-20T16:05:10.965Z","__v":0,"parentDoc":null}

get/payouts.xml (BETA)

Returns a collection of payouts.

Definition

{{ api_url }}{{ page_api_url }}

Result Format


Documentation

[block:callout] { "type": "info", "body": "Maximum is 100 entries, use the page parameter to get the next results.\n\n(with pagination: /payouts.xml?page={page_number})" } [/block] List by criterias GET /payouts.xml?criteria[amount_min]={value}&criteria[amount_max]={value}&page={page_number} Returns a collection of payouts that fits to a given criteria array. Maximum is 100 entries, use the page parameter to get the next results. These criteria are currently available: amount_min amount_max created_time_min created_time_max external_payout_id fb_type_id id_min id_max [block:callout] { "type": "info", "body": "If no payouts with these criteria exist, an empty payouts container will be returned." } [/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 }}