{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/v:version/payouts/:id.json","auth":"required","results":{"codes":[{"status":200,"language":"json","code":"{\n    \"id\":12345,\n    \"fb_type_id\":3,\n    \"created_time\":\"2019-03-15 14:31:29\",\n    \"amount\":1234.5,\n    \"amount_donations\":89.12,\n    \"amount_donations_fee\":-1.2,\n    \"amount_reversed_donations\":12.3,\n    \"amount_reversed_donations_fee\":0.34,\n    \"amount_unknown\":5.6,\n    \"currency\":\"EUR\",\n    \"external_payout_id\":\"1378051118\",\n    \"created_at\":\"2019-03-18 12:31:56\",\n    \"updated_at\":\"2019-03-18 12:31:56\"\n}","name":""}]},"settings":"","examples":{"codes":[{"code":"","language":"text"}]},"method":"get","params":[{"name":"id","type":"int","default":"","desc":"Payout ID","required":true,"in":"path","ref":"","_id":"571f829ae54f2d0e003ebadb"}]},"next":{"description":"","pages":[]},"title":"/payouts/:id.json","type":"endpoint","slug":"payouts-show","excerpt":"Returns a single payout.","body":"Shows a single payout with a given ID.\n\nField descriptions:\n  * **fb_type_id**: See [Predefined values](doc:predefined-values)\n  * **created_time**: time the payout has been created by the payment provider\n  * **amount**: transferred amount to the bank account\n  * **amount_donations**: sum of the amount of the assigned fb_donations\n  * **amount_donations_fee**: sum of the payment provider fees of the assigend fb_donations (negative number)\n  * **amount_reversed_donations**: sum of the amount of the recognized reversed fb_donations (negative number)\n  * **amount_reversed_donations_fee**: sum of the payment provider fees of the recognized reversed fb_donations (can be negative (e.g. dispute fee) or positive (e.g. refunded fee))\n  * **amount_unknown**: sum of the amount of the unknown transactions found in this payout (not initiated by FundraisingBox)\n  * **currency**: See [Predefined values](doc:predefined-values)\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Retrieve connected fb_donations\",\n  \"body\": \"If you want to retrieve the connected donations to a payout, you can use the [donations-API](doc:donationsxml) with criteria fb_payout_id, for example:\\n**GET /donations.xml?criteria[fb_payout_id]={id}**\"\n}\n[/block]","updates":[],"order":20,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5cbeff01862d090013abd764","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-23T12:03:13.363Z","__v":7,"parentDoc":null}

get/payouts/:id.json

Returns a single payout.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

id:
required
integer
Payout ID

Result Format


Documentation

Shows a single payout with a given ID. Field descriptions: * **fb_type_id**: See [Predefined values](doc:predefined-values) * **created_time**: time the payout has been created by the payment provider * **amount**: transferred amount to the bank account * **amount_donations**: sum of the amount of the assigned fb_donations * **amount_donations_fee**: sum of the payment provider fees of the assigend fb_donations (negative number) * **amount_reversed_donations**: sum of the amount of the recognized reversed fb_donations (negative number) * **amount_reversed_donations_fee**: sum of the payment provider fees of the recognized reversed fb_donations (can be negative (e.g. dispute fee) or positive (e.g. refunded fee)) * **amount_unknown**: sum of the amount of the unknown transactions found in this payout (not initiated by FundraisingBox) * **currency**: See [Predefined values](doc:predefined-values) [block:callout] { "type": "info", "title": "Retrieve connected fb_donations", "body": "If you want to retrieve the connected donations to a payout, you can use the [donations-API](doc:donationsxml) with criteria fb_payout_id, for example:\n**GET /donations.xml?criteria[fb_payout_id]={id}**" } [/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 }}