{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/v:version/payouts.json","auth":"required","settings":"","examples":{"codes":[]},"method":"get","results":{"codes":[{"status":200,"language":"xml","code":"{\n \"hasMore\":true,\n \"data\":[\n {\n \"id\":123,\n ...\n },\n {\n \"id\":124,\n ...\n },\n {\n \"id\":125,\n ...\n }\n ]\n}","name":""}]},"params":[{"name":"page","type":"int","default":"1","desc":"page number","required":false,"in":"path","ref":"","_id":"5cd438c1d9d25c01cc78cb79"},{"name":"perPage","type":"int","default":"100","desc":"number of objects per page","required":false,"in":"path","ref":"","_id":"5cd438c1d9d25c01cc78cb78"}]},"next":{"description":"","pages":[]},"title":"/payouts.json","type":"endpoint","slug":"payouts-list","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 \"title\": \"Pagination\"\n}\n[/block]\n\n[block:api-header]\n{\n \"title\": \"Filter by criteria\"\n}\n[/block]\nGET /payouts.json?amount_min={value}&amount_max={value}&page={page_number}\n\nReturns a collection of payouts that fits to the given criteria.\n\nThese criteria are currently available:\n[block:parameters]\n{\n \"data\": {\n \"h-0\": \"Criterion\",\n \"h-1\": \"Description\",\n \"h-2\": \"Type\",\n \"0-0\": \"amount_min\",\n \"1-0\": \"amount_max\",\n \"2-0\": \"created_time_min\",\n \"3-0\": \"created_time_max\",\n \"4-0\": \"external_payout_id\",\n \"5-0\": \"fb_type_id\",\n \"6-0\": \"id_min\",\n \"7-0\": \"id_max\",\n \"7-2\": \"integer\",\n \"6-2\": \"integer\",\n \"5-2\": \"integer\",\n \"4-2\": \"string\",\n \"0-2\": \"float\",\n \"1-2\": \"float\",\n \"2-2\": \"datetime\",\n \"3-2\": \"datetime\",\n \"5-1\": \"An ID of a payment type\",\n \"6-1\": \"Minimum ID\",\n \"7-1\": \"Maximum ID\",\n \"4-1\": \"The external ID of the payment\",\n \"0-1\": \"Minimum amount\",\n \"1-1\": \"Maximum amount\",\n \"2-1\": \"Minimum creation time\",\n \"3-1\": \"Maximum creation time\"\n },\n \"cols\": 3,\n \"rows\": 8\n}\n[/block]\n\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":19,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5cbef4e66a2e8b003704013f","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-23T11:20:06.711Z","__v":1,"parentDoc":null}
get/payouts.json
Returns a collection of payouts.
Definition
{{ api_url }}{{ page_api_url }}
Parameters
Path Params
page:
integer1
page number
perPage:
integer100
number of objects per page