{"_id":"58af2bd912cf192700afef78","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"},"parentDoc":null,"user":"55dd080d0efd5821000d53b3","category":{"_id":"58af1bf6ebd7370f0078ba09","__v":0,"project":"55dd0853d2d97337001800e2","version":"55de36ec9067202b00de0015","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2017-02-23T17:29:26.972Z","from_sync":false,"order":12,"slug":"payouts","title":"Payouts"},"githubsync":"","__v":0,"project":"55dd0853d2d97337001800e2","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-02-23T18:37:13.358Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":7,"body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"FundingType\",\n  \"body\": \"* __*fund_only*__: The payout is to be completely funded using the included fund.\\n* __escrow_only__: The payout is to be completely funded using the customer's Accounts Payable escrow balance.\\n* __ escrow_or_fund__: The payout is to be completely funded from either the customer's Accounts Payable escrow balance, provided there are enough funds in the escrow, or otherwise from the included fund.\\n* __ escrow_and_fund__: The payout is to be funded exhausting the customer's Accounts Payable escrow balance first and if that doesn't cover the complete payout, draw the remainder from the included fund.\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"Bank based payout funding only\",\n  \"body\": \"Currently, **only bank based payout funding** is supported. I.e. \\\"fund_only\\\" is the only supported FundingType and banks are the only supported funding source. Practically this means that any payout should include a bankId to fund the payout and the fundingType should always be set to \\\"fund_only\\\".\"\n}\n[/block]\n\n## Request\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Parameter\",\n    \"h-1\": \"Specifications\",\n    \"2-0\": \"amount\",\n    \"3-0\": \"currency\",\n    \"7-0\": \"description\",\n    \"8-0\": \"meta\",\n    \"2-1\": \"**Type**: String\\n**Format**: Positive Decimal String\\n**Example**: \\\"10.00\\\"\\n**Description**: The amount to be payed out as a decimal string.\",\n    \"3-1\": \"**Type**: String\\n**Format**: ISO4217 Currency Code\\n**Example**: \\\"USD\\\"\\n**Description**: The currency for the payment amount.\",\n    \"7-1\": \"**Type**: String\\n**Length**: 0-512 characters\\n**Description**: An optional short description that describes the reason for the refund.\",\n    \"8-1\": \"**Type**: JSON Object\\n**Format**: [Meta](/docs/meta) \\n**Description**: An optional object to store custom data for the Payment.\",\n    \"0-1\": \"**Type**: String\\n**Format**: PayStand Id\\n**Description**: The PayStand Id for the card that is to be charged to fund this payout.\",\n    \"0-0\": \"cardId__*__\",\n    \"1-0\": \"bankId\",\n    \"1-1\": \"**Type**: String\\n**Format**: PayStand Id\\n**Description**: The PayStand Id for the bank that is to be charged for this payment.\",\n    \"4-0\": \"vendorId\",\n    \"4-1\": \"**Type**: String\\n**Format**: PayStand Id\\n**Description**: The PayStand Id for the vendor that is to receive the payout.\",\n    \"5-0\": \"fundingType__**__\",\n    \"5-1\": \"**Type**: String\\n**Example**: \\\"fund_only\\\"\\n**Description**: The Payout's funding method\",\n    \"6-0\": \"externalId\",\n    \"6-1\": \"**Type**: String\\n**Length**: 0-128 characters\\n**Description**: An optional short external system identifier to be associated with the payout.\"\n  },\n  \"cols\": 2,\n  \"rows\": 9\n}\n[/block]\n__*__ At this moment, PayStand only supports verified bank accounts as funding sources.\n__**__ \"fund_only\" is currently the only supported fundType.\n__\\***__ Only 1 fund can be included for funding purposes, be it bank or in the future possibly card.\n\n## Response\n\nWith the exception of the \"cardId\" and \"bankId\" parameters, all Request values are returned in the Response. In addition, the following parameters are also returned in a payment 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\": \"depositId\",\n    \"3-0\": \"status\",\n    \"5-0\": \"created\",\n    \"5-1\": \"The date the payment was created.\",\n    \"6-0\": \"lastUpdated\",\n    \"0-1\": \"The unique identifier for the payout.\",\n    \"6-1\": \"The date the payment was last updated.\",\n    \"1-1\": \"Will have value \\\"payout\\\" indicating that the object is a payout response.\",\n    \"3-1\": \"The current status of the payment. One of: \\\"created\\\", \\\"processing\\\", \\\"posted\\\", \\\"paid\\\", \\\"failed\\\"\",\n    \"2-1\": \"The related deposit Id in case there was funding outside of the escrow balance.\",\n    \"4-0\": \"payoutType\",\n    \"4-1\": \"The current customer (x-customer-id) relationship to the Payout. One of: \\\"sender\\\", \\\"receiver\\\"\"\n  },\n  \"cols\": 2,\n  \"rows\": 7\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"amount\\\": \\\"2000.00\\\",\\n  \\\"fundingType\\\": \\\"fund_only\\\",\\n  \\\"bankId\\\": \\\"e55kw3molprvkh0fm42utqz6\\\",\\n  \\\"vendorId\\\": \\\"227dzij9qengkide1x2ln3zw\\\",\\n  \\\"externalId\\\": \\\"10023\\\",\\n  \\\"description\\\": \\\"Vendor Enterprises January Invoice\\\",\\n  \\\"meta\\\": {\\n    \\\"terms\\\": \\\"net30\\\",\\n    \\\"internal\\\": {\\n      \\\"project\\\": \\\"Good Riddance\\\"\\n    }\\n  }\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Request\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"amount\\\": \\\"2000.00\\\",\\n  \\\"currency\\\": \\\"USD\\\",\\n  \\\"vendorId\\\": \\\"80uhozbkyflokvldgwsjrked\\\",\\n  \\\"depositId\\\": \\\"qqpkdwzbt80tjfp7bhdi94w9\\\",\\n  \\\"fundingType\\\": \\\"fund_only\\\",\\n  \\\"meta\\\": {\\n    \\\"terms\\\": \\\"net30\\\",\\n    \\\"internal\\\": {\\n      \\\"project\\\": \\\"Good Riddance\\\"\\n    }\\n  },\\n  \\\"created\\\": \\\"2017-02-15T19:20:09.000Z\\\",\\n  \\\"lastUpdated\\\": \\\"2017-02-15T19:20:10.000Z\\\",\\n  \\\"status\\\": \\\"posted\\\",\\n  \\\"id\\\": \\\"aq04doxwxjyrpukkh4qzr00h\\\",\\n  \\\"externalId\\\": \\\"10023\\\",\\n  \\\"description\\\": \\\"Vendor Enterprises January Invoice\\\",\\n  \\\"object\\\": \\\"payout\\\",\\n  \\\"payoutType\\\": \\\"sender\\\"\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Response\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","excerpt":"","slug":"payout-resource","type":"basic","title":"Payout resource"}
[block:callout] { "type": "info", "title": "FundingType", "body": "* __*fund_only*__: The payout is to be completely funded using the included fund.\n* __escrow_only__: The payout is to be completely funded using the customer's Accounts Payable escrow balance.\n* __ escrow_or_fund__: The payout is to be completely funded from either the customer's Accounts Payable escrow balance, provided there are enough funds in the escrow, or otherwise from the included fund.\n* __ escrow_and_fund__: The payout is to be funded exhausting the customer's Accounts Payable escrow balance first and if that doesn't cover the complete payout, draw the remainder from the included fund.", "sidebar": true } [/block] [block:callout] { "type": "warning", "title": "Bank based payout funding only", "body": "Currently, **only bank based payout funding** is supported. I.e. \"fund_only\" is the only supported FundingType and banks are the only supported funding source. Practically this means that any payout should include a bankId to fund the payout and the fundingType should always be set to \"fund_only\"." } [/block] ## Request [block:parameters] { "data": { "h-0": "Parameter", "h-1": "Specifications", "2-0": "amount", "3-0": "currency", "7-0": "description", "8-0": "meta", "2-1": "**Type**: String\n**Format**: Positive Decimal String\n**Example**: \"10.00\"\n**Description**: The amount to be payed out as a decimal string.", "3-1": "**Type**: String\n**Format**: ISO4217 Currency Code\n**Example**: \"USD\"\n**Description**: The currency for the payment amount.", "7-1": "**Type**: String\n**Length**: 0-512 characters\n**Description**: An optional short description that describes the reason for the refund.", "8-1": "**Type**: JSON Object\n**Format**: [Meta](/docs/meta) \n**Description**: An optional object to store custom data for the Payment.", "0-1": "**Type**: String\n**Format**: PayStand Id\n**Description**: The PayStand Id for the card that is to be charged to fund this payout.", "0-0": "cardId__*__", "1-0": "bankId", "1-1": "**Type**: String\n**Format**: PayStand Id\n**Description**: The PayStand Id for the bank that is to be charged for this payment.", "4-0": "vendorId", "4-1": "**Type**: String\n**Format**: PayStand Id\n**Description**: The PayStand Id for the vendor that is to receive the payout.", "5-0": "fundingType__**__", "5-1": "**Type**: String\n**Example**: \"fund_only\"\n**Description**: The Payout's funding method", "6-0": "externalId", "6-1": "**Type**: String\n**Length**: 0-128 characters\n**Description**: An optional short external system identifier to be associated with the payout." }, "cols": 2, "rows": 9 } [/block] __*__ At this moment, PayStand only supports verified bank accounts as funding sources. __**__ "fund_only" is currently the only supported fundType. __\***__ Only 1 fund can be included for funding purposes, be it bank or in the future possibly card. ## Response With the exception of the "cardId" and "bankId" parameters, all Request values are returned in the Response. In addition, the following parameters are also returned in a payment response. [block:parameters] { "data": { "h-0": "Parameter", "h-1": "Description", "0-0": "id", "1-0": "object", "2-0": "depositId", "3-0": "status", "5-0": "created", "5-1": "The date the payment was created.", "6-0": "lastUpdated", "0-1": "The unique identifier for the payout.", "6-1": "The date the payment was last updated.", "1-1": "Will have value \"payout\" indicating that the object is a payout response.", "3-1": "The current status of the payment. One of: \"created\", \"processing\", \"posted\", \"paid\", \"failed\"", "2-1": "The related deposit Id in case there was funding outside of the escrow balance.", "4-0": "payoutType", "4-1": "The current customer (x-customer-id) relationship to the Payout. One of: \"sender\", \"receiver\"" }, "cols": 2, "rows": 7 } [/block] [block:code] { "codes": [ { "code": "{\n \"amount\": \"2000.00\",\n \"fundingType\": \"fund_only\",\n \"bankId\": \"e55kw3molprvkh0fm42utqz6\",\n \"vendorId\": \"227dzij9qengkide1x2ln3zw\",\n \"externalId\": \"10023\",\n \"description\": \"Vendor Enterprises January Invoice\",\n \"meta\": {\n \"terms\": \"net30\",\n \"internal\": {\n \"project\": \"Good Riddance\"\n }\n }\n}", "language": "json", "name": "Request" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"amount\": \"2000.00\",\n \"currency\": \"USD\",\n \"vendorId\": \"80uhozbkyflokvldgwsjrked\",\n \"depositId\": \"qqpkdwzbt80tjfp7bhdi94w9\",\n \"fundingType\": \"fund_only\",\n \"meta\": {\n \"terms\": \"net30\",\n \"internal\": {\n \"project\": \"Good Riddance\"\n }\n },\n \"created\": \"2017-02-15T19:20:09.000Z\",\n \"lastUpdated\": \"2017-02-15T19:20:10.000Z\",\n \"status\": \"posted\",\n \"id\": \"aq04doxwxjyrpukkh4qzr00h\",\n \"externalId\": \"10023\",\n \"description\": \"Vendor Enterprises January Invoice\",\n \"object\": \"payout\",\n \"payoutType\": \"sender\"\n}", "language": "json", "name": "Response" } ], "sidebar": true } [/block]