{"_id":"565e02e360497d1700ecce5c","githubsync":"","version":{"_id":"55de36ec9067202b00de0015","__v":33,"project":"55dd0853d2d97337001800e2","createdAt":"2015-08-26T22:00:12.384Z","releaseDate":"2015-08-26T22:00:12.383Z","categories":["55de36ed9067202b00de0016","55de36ed9067202b00de0017","55de36ed9067202b00de0018","55df7dcd437b3f0d004ba204","55e4e014177b6e0d00333141","55e4e01fe252ac0d00303a99","55e4e05240cda60d003bad67","55e4e070177b6e0d00333142","55e4e0753325e60d007fbee6","55e4e0803325e60d007fbee7","55e4e086177b6e0d00333143","55e4e0a1177b6e0d00333144","55e4e0aa3325e60d007fbee8","55e4e0b140cda60d003bad6b","55e4e0bae252ac0d00303a9d","55e4e0c5177b6e0d00333145","55e4e0ee3325e60d007fbeea","55e4e0fae252ac0d00303a9e","55e4e100177b6e0d00333147","55f85c8ba3271b0d00498d55","56092e1ac5cff70d007d0131","564b64a3ee12850d0095866e","564b64b5791099170071e9ea","565cd0bfd18ae50d007183d8","565f5f5d6bafd40d0030a063","565f790d6bafd40d0030a09f","56611c464851190d003f9f5d","56637d5b7988ab0d00d0522e","56637d687988ab0d00d0522f","567835df6928b40d009dd650","56e59c043c29b117008dae5b","5704013559c5190e000ab646","572be252de40590e00026934","58af1bf6ebd7370f0078ba09","5cdad81d912ece0039e9a939"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"3.0.0","version":"3.0"},"__v":5,"user":"55f8467359eace0d0087db7e","parentDoc":null,"category":{"_id":"55e4e0c5177b6e0d00333145","project":"55dd0853d2d97337001800e2","version":"55de36ec9067202b00de0015","__v":7,"pages":["55e5ec3a6015ce1900eadc1c","55ea28cc4f4b23230046f705","55ea290f0b48a121002ab401","55ea299bb44f7b1700e452aa","55ea29c9b44f7b1700e452ab","565e02e360497d1700ecce5c","565e0b1460497d1700ecce6b"],"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2015-08-31T23:18:29.848Z","from_sync":false,"order":18,"slug":"withdrawals","title":"Withdrawals"},"project":"55dd0853d2d97337001800e2","updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-12-01T20:28:19.494Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":true,"order":0,"body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"In order to receive money earned from Payments, Withdrawals need to be issued using the Withdrawal resource.\"\n}\n[/block]\n## Request\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"amount\",\n    \"1-0\": \"currency\",\n    \"3-0\": \"description\",\n    \"4-0\": \"meta\",\n    \"h-0\": \"Parameter\",\n    \"h-1\": \"Specification\",\n    \"0-1\": \"**Type**: String\\n**Format**: Positive Decimal String\\n**Example**: \\\"10.20\\\"\\n**Description**: The requested refund amount as a decimal string.\",\n    \"1-1\": \"**Type**: String\\n**Format**: ISO4217 Currency Code\\n**Example**: \\\"USD\\\"\\n**Description**: The currency for the refund amount.\",\n    \"3-1\": \"**Type**: String\\n**Length**: 0-512 characters\\n**Description**: An optional short description that describes the reason for the refund.\",\n    \"4-1\": \"**Type**: JSON Object\\n**Format**: [Meta](doc:meta) \\n**Description**: An optional object to store custom data for the Payment.\",\n    \"2-0\": \"bankId\",\n    \"2-1\": \"**Type**: String\\n**Length**: 0-128\\n**Example**: \\\"e739d35f8cb84c9abb5a144d\\\"\\n**Description**: The bankId to send the withdrawal to. The bank must be both two-drop verified and owned by the merchant customer.\"\n  },\n  \"cols\": 2,\n  \"rows\": 5\n}\n[/block]\n## Response\n\nAll of the Request parameters will be returned in the Response object. In addition, the following parameters will also be returned in the response:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Parameter\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"id\",\n    \"1-0\": \"object\",\n    \"2-0\": \"status\",\n    \"3-0\": \"created\",\n    \"4-0\": \"lastUpdated\",\n    \"0-1\": \"The unique identifier for the withdrawal.\",\n    \"1-1\": \"Will have value \\\"withdrawal\\\" indicating that the object is a withdrawal response.\",\n    \"4-1\": \"The date the withdrawal was last updated.\",\n    \"3-1\": \"The date the withdrawal was created.\",\n    \"2-1\": \"The current status of the withdrawal. One of: \\\"created\\\", \\\"processing\\\", \\\"posted\\\", \\\"paid\\\", \\\"failed\\\".\"\n  },\n  \"cols\": 2,\n  \"rows\": 5\n}\n[/block]","excerpt":"","slug":"withdrawal-resource","type":"basic","title":"Withdrawal resource"}

Withdrawal resource


[block:callout] { "type": "info", "body": "In order to receive money earned from Payments, Withdrawals need to be issued using the Withdrawal resource." } [/block] ## Request [block:parameters] { "data": { "0-0": "amount", "1-0": "currency", "3-0": "description", "4-0": "meta", "h-0": "Parameter", "h-1": "Specification", "0-1": "**Type**: String\n**Format**: Positive Decimal String\n**Example**: \"10.20\"\n**Description**: The requested refund amount as a decimal string.", "1-1": "**Type**: String\n**Format**: ISO4217 Currency Code\n**Example**: \"USD\"\n**Description**: The currency for the refund amount.", "3-1": "**Type**: String\n**Length**: 0-512 characters\n**Description**: An optional short description that describes the reason for the refund.", "4-1": "**Type**: JSON Object\n**Format**: [Meta](doc:meta) \n**Description**: An optional object to store custom data for the Payment.", "2-0": "bankId", "2-1": "**Type**: String\n**Length**: 0-128\n**Example**: \"e739d35f8cb84c9abb5a144d\"\n**Description**: The bankId to send the withdrawal to. The bank must be both two-drop verified and owned by the merchant customer." }, "cols": 2, "rows": 5 } [/block] ## Response All of the Request parameters will be returned in the Response object. In addition, the following parameters will also be returned in the response: [block:parameters] { "data": { "h-0": "Parameter", "h-1": "Description", "0-0": "id", "1-0": "object", "2-0": "status", "3-0": "created", "4-0": "lastUpdated", "0-1": "The unique identifier for the withdrawal.", "1-1": "Will have value \"withdrawal\" indicating that the object is a withdrawal response.", "4-1": "The date the withdrawal was last updated.", "3-1": "The date the withdrawal was created.", "2-1": "The current status of the withdrawal. One of: \"created\", \"processing\", \"posted\", \"paid\", \"failed\"." }, "cols": 2, "rows": 5 } [/block]