{"_id":"58af1cef4adb7e1b00f07d3b","user":"55dd080d0efd5821000d53b3","githubsync":"","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"},"project":"55dd0853d2d97337001800e2","__v":0,"parentDoc":null,"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"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-02-23T17:33:35.367Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":0,"body":"[block:callout]\n{\n  \"type\": \"danger\",\n  \"title\": \"BETA DOCUMENTATION WARNING!!!\",\n  \"body\": \"Please note that the documentation for the Payouts API for Private Network Platform is still under review. Please report any questions or concerns to your PayStand Integration manager.\"\n}\n[/block]\nAt this moment, _**PayStand only supports Payouts for Private Network Platforms**_. PayStand does not yet support direct public payouts.\n[block:callout]\n{\n  \"type\": \"success\",\n  \"title\": \"Payouts for Private Network Platforms\",\n  \"body\": \"Payouts for Private Network Platforms are, as the name implies, payouts that are **performed by a platform** between 2 parties which are **both customers of** said platform.\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:html]\n{\n  \"html\": \"<br>\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"1. Get signed up as a Payouts Platform\"\n}\n[/block]\nTo get started, please get in touch with PayStand Sales to understand PayStand's offering and sign-up for the Payouts Platform plan that best suites your needs.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Contact PayStand Sales\",\n  \"body\": \"# Call:    1 (800) 708-6413\\nThe PayStand Sales team is at your service every weekday from 9 am to  6 pm PT.\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:html]\n{\n  \"html\": \"<br>\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"2. Understand PayStand's APIs\"\n}\n[/block]\nThough PayStand's APIs will be immediately familiar to anyone who ever programmed against a JSON based REST API, there are a couple particularities that are important to understand, specifically the relationship between an authenticated Application (or User), a customer, and the platform.\n\nEach of these has its own HTTP Request header entry\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Header\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"Authorization\",\n    \"0-1\": \"Authorized Application (or User) token\",\n    \"1-0\": \"x&#8209;customer&#8209;id\",\n    \"1-1\": \"The customer id on whose behalf the authorized application (or user) is performing the operation\"\n  },\n  \"cols\": 2,\n  \"rows\": 2\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"The x-customer-id\",\n  \"body\": \"For platform specific API calls (e.g. creating another customer), the x-customer-id should be the platform's customer id. Subsequent call made by the platform on behalf of a child customer, should typically carry the customer id of that child customer. Applications and users authorized to operate on behalf of platform customer automatically are also authorized to operate on behalf of the platforms child customers.\"\n}\n[/block]\nFor more information check out [Getting API Access](doc:getting-api-access).\n[block:html]\n{\n  \"html\": \"<br>\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"3. Understand PayStand Payouts\"\n}\n[/block]\nA good way to get familiar with PayStand's Payouts for Private Network Platforms feature, is to review the Signup and Payout Implementation overview which is part of this introduction.\n* [Signup Implementation](doc:payouts-signup-implementation)\n* [Payouts Implementation](doc:payouts-implementation)\n\nAfter that a deeper dive into the payout specific resources and the supported API operations is recommended:\n* [Vendor resource](doc:vendor-resource)\n* [Payout resource](doc:payout-resource) \n\nLastly since Payouts hinges on the Customer resource, it is worthwhile going back and reviewing this resource: [Customer resource](doc:the-customer-resource) \n\n[block:html]\n{\n  \"html\": \"<br>\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"4. Sandbox: implement and integrate\"\n}\n[/block]\nOnce the business side is taken care of, PayStand will onboard a test customer on our sandbox environment (paystand.co). Your PayStand integration manager will provide you with the necessary API credentials to get started implementing and integrating.\n\nThe credentials include your platform:\n* customer id\n* client application id\n* client application secret\n* a set of plan keys\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Plan Keys\",\n  \"body\": \"A platform customer will receive a set of plan keys that can be used by its platform to create new customer accounts.  For Payout Platforms, typically there are 2 keys. One to create payout sender customers and one to create payout receiver (vendor) customers. However the exact number of keys and the functionality available to each plan depends on the business terms set forward in the platforms PayStand contract.\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"danger\",\n  \"title\": \"DO NOT use real customer or payout information in sandbox\",\n  \"body\": \"While both PayStand's production and sandbox environment adhere to the strictest security standards, PayStand strongly discourages the use of any real customer data in a non-production environment.\\n\\nPlease see [Test cards](doc:test-cards) for testing credentials.\"\n}\n[/block]\nThe role of your assigned integration manager is:\n* Answer any implementation questions you may have\n* Certify that your implementation is ready to move to production\n\nThe production readiness certification will establish that your platform implementation is ready for production by requiring you to run your system through its paces against sandbox. Your integration manager will let you know what flows he expects to be run against the API and will verify sandbox logs to make sure everything worked as expected.\n[block:html]\n{\n  \"html\": \"<br>\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"5. Go live!\"\n}\n[/block]\nAfter you have received your production readiness certification, PayStand will onboard your organization onto PayStand's production platform. Your assigned integration manager or a customer success representative may contact you to collect additional information and/or documentation as needed by our internal underwriting team or banking partners.\n\nOnce your account is operational in production, you will be provided with a similar set of credentials as the one your received for sandbox, but which will only work on production. With these you can start signing your own customers up and have them pay each other out!","excerpt":"with Payouts for Private Network Platforms","slug":"payouts-steps-to-go-live","type":"basic","title":"Steps to Go Live!"}

Steps to Go Live!

with Payouts for Private Network Platforms

[block:callout] { "type": "danger", "title": "BETA DOCUMENTATION WARNING!!!", "body": "Please note that the documentation for the Payouts API for Private Network Platform is still under review. Please report any questions or concerns to your PayStand Integration manager." } [/block] At this moment, _**PayStand only supports Payouts for Private Network Platforms**_. PayStand does not yet support direct public payouts. [block:callout] { "type": "success", "title": "Payouts for Private Network Platforms", "body": "Payouts for Private Network Platforms are, as the name implies, payouts that are **performed by a platform** between 2 parties which are **both customers of** said platform.", "sidebar": true } [/block] [block:html] { "html": "<br>" } [/block] [block:api-header] { "type": "basic", "title": "1. Get signed up as a Payouts Platform" } [/block] To get started, please get in touch with PayStand Sales to understand PayStand's offering and sign-up for the Payouts Platform plan that best suites your needs. [block:callout] { "type": "info", "title": "Contact PayStand Sales", "body": "# Call: 1 (800) 708-6413\nThe PayStand Sales team is at your service every weekday from 9 am to 6 pm PT.", "sidebar": true } [/block] [block:html] { "html": "<br>" } [/block] [block:api-header] { "type": "basic", "title": "2. Understand PayStand's APIs" } [/block] Though PayStand's APIs will be immediately familiar to anyone who ever programmed against a JSON based REST API, there are a couple particularities that are important to understand, specifically the relationship between an authenticated Application (or User), a customer, and the platform. Each of these has its own HTTP Request header entry [block:parameters] { "data": { "h-0": "Header", "h-1": "Description", "0-0": "Authorization", "0-1": "Authorized Application (or User) token", "1-0": "x&#8209;customer&#8209;id", "1-1": "The customer id on whose behalf the authorized application (or user) is performing the operation" }, "cols": 2, "rows": 2 } [/block] [block:callout] { "type": "warning", "title": "The x-customer-id", "body": "For platform specific API calls (e.g. creating another customer), the x-customer-id should be the platform's customer id. Subsequent call made by the platform on behalf of a child customer, should typically carry the customer id of that child customer. Applications and users authorized to operate on behalf of platform customer automatically are also authorized to operate on behalf of the platforms child customers." } [/block] For more information check out [Getting API Access](doc:getting-api-access). [block:html] { "html": "<br>" } [/block] [block:api-header] { "type": "basic", "title": "3. Understand PayStand Payouts" } [/block] A good way to get familiar with PayStand's Payouts for Private Network Platforms feature, is to review the Signup and Payout Implementation overview which is part of this introduction. * [Signup Implementation](doc:payouts-signup-implementation) * [Payouts Implementation](doc:payouts-implementation) After that a deeper dive into the payout specific resources and the supported API operations is recommended: * [Vendor resource](doc:vendor-resource) * [Payout resource](doc:payout-resource) Lastly since Payouts hinges on the Customer resource, it is worthwhile going back and reviewing this resource: [Customer resource](doc:the-customer-resource) [block:html] { "html": "<br>" } [/block] [block:api-header] { "type": "basic", "title": "4. Sandbox: implement and integrate" } [/block] Once the business side is taken care of, PayStand will onboard a test customer on our sandbox environment (paystand.co). Your PayStand integration manager will provide you with the necessary API credentials to get started implementing and integrating. The credentials include your platform: * customer id * client application id * client application secret * a set of plan keys [block:callout] { "type": "info", "title": "Plan Keys", "body": "A platform customer will receive a set of plan keys that can be used by its platform to create new customer accounts. For Payout Platforms, typically there are 2 keys. One to create payout sender customers and one to create payout receiver (vendor) customers. However the exact number of keys and the functionality available to each plan depends on the business terms set forward in the platforms PayStand contract.", "sidebar": true } [/block] [block:callout] { "type": "danger", "title": "DO NOT use real customer or payout information in sandbox", "body": "While both PayStand's production and sandbox environment adhere to the strictest security standards, PayStand strongly discourages the use of any real customer data in a non-production environment.\n\nPlease see [Test cards](doc:test-cards) for testing credentials." } [/block] The role of your assigned integration manager is: * Answer any implementation questions you may have * Certify that your implementation is ready to move to production The production readiness certification will establish that your platform implementation is ready for production by requiring you to run your system through its paces against sandbox. Your integration manager will let you know what flows he expects to be run against the API and will verify sandbox logs to make sure everything worked as expected. [block:html] { "html": "<br>" } [/block] [block:api-header] { "type": "basic", "title": "5. Go live!" } [/block] After you have received your production readiness certification, PayStand will onboard your organization onto PayStand's production platform. Your assigned integration manager or a customer success representative may contact you to collect additional information and/or documentation as needed by our internal underwriting team or banking partners. Once your account is operational in production, you will be provided with a similar set of credentials as the one your received for sandbox, but which will only work on production. With these you can start signing your own customers up and have them pay each other out!