{"_id":"564ab7c34cd0521700523f19","parentDoc":null,"project":"55dd0853d2d97337001800e2","category":{"_id":"55df7dcd437b3f0d004ba204","pages":["55df7ef3a50de10d00062f70","55e0f40126f51b0d009b171c","55e0f57c7d91840d00824934","55e0f605c13a5a0d00880e6b","55e100eed052580d0038c993","55e1013d26f51b0d009b1759","55e101637d91840d0082493c","55e5f5af9416190d00dc3a59","55e6203dd101191900f30d11","55ea2468ba33bc3500b28cd9","55f85c32a3271b0d00498d51","55f8b70fc449610d002daf9f","56092bafa7cc2f0d00d975b2","56092bd58aedf50d0004cff1","563923d13539050d000820f0","563e732531f7580d00511edf","564a83ec4721851900a67614","564ab6274cd0521700523f17","564ab687c58bef0d0062070a","564ab6ee9f35450d00fc767a","564ab75f33fb500d00567ddd","564ab7c34cd0521700523f19","564ab82233fb500d00567ddf","564b5f0755cfbe0d00de3ba5","564b5f7e55cfbe0d00de3ba7","565cf59677f0090d00581807","565e4266f76b8d0d00554185","565f4119de5dc50d00acfe30","5665c0b8d7490819006a4fd6"],"project":"55dd0853d2d97337001800e2","version":"55de36ec9067202b00de0015","__v":29,"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2015-08-27T21:14:53.972Z","from_sync":false,"order":2,"slug":"customers","title":"Customers"},"githubsync":"","user":"55f84b9660cc850d008a7afc","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":29,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-11-17T05:14:43.843Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[]},"auth":"required","params":[],"url":""},"isReference":true,"order":4,"body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Settings vs. Default Settings\",\n  \"body\": \"When creating a Merchant Customer, you can provide a settings parameter in your request. If you choose not to provide a settings parameter in your request, the Default Settings on the Platform Customer will be created for the Merchant Customer.\\n\\nDefault Settings are only applicable for Platform Customers.\"\n}\n[/block]\n## Request\n[block:callout]\n{\n  \"type\": \"success\",\n  \"title\": \"Enable events!\",\n  \"body\": \"Be sure to enabled events and provide at least one webhook event url. **Events are not enabled by default**.\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"body\": \"Failure to enable events and to provide a valid webhook event url may result in missing important resource responses or updates.\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"danger\",\n  \"title\": \"Security Considerations\",\n  \"body\": \"PayStand highly recommends setting all event webhook urls to be HTTPS. PayStand does not enforce this requirement but customers should be aware that failure to provide HTTPS urls does have security implications.\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-2\": \"Value Format / Requirements**\",\n    \"h-0\": \"Element\",\n    \"h-1\": \"Specification\",\n    \"h-3\": \"Notes\",\n    \"0-0\": \"events.enabled\",\n    \"0-1\": \"**Type**: Boolean\\n**Example**: true\\n**Description**: Set to true if events are enabled\",\n    \"0-2\": \"true or false\",\n    \"1-0\": \"events.urls.always\",\n    \"1-3\": \"The url that all webhooks will always be sent to.\",\n    \"0-3\": \"Whether or not events are to be sent. Defaults to false.\",\n    \"1-1\": \"**Type**: Array of Url Strings\\n**Format**: Array of Valid Url\\n**Example**: [\\\"https://www.mySite.com/myWebhookReceiver\\\"]\\n**Description**: An array of urls for events to be sent to.\"\n  },\n  \"cols\": 2,\n  \"rows\": 2\n}\n[/block]\n## Response\n\nAll of the request parameters will be returned in the response.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n\\t\\\"customer\\\": {\\n  \\t\\\"settings\\\": {\\n\\t\\t\\t\\\"events\\\": {\\n        \\\"enabled\\\": true,\\n        \\\"urls\\\": {\\n        \\t\\\"always\\\": [\\\"https://www.mySite.com/myWebhookReceiver\\\"]\\n        }\\n      }\\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\\t\\\"customer\\\": {\\n  \\t\\\"settings\\\": {\\n\\t\\t\\t\\\"events\\\": {\\n        \\\"enabled\\\": true,\\n        \\\"urls\\\": {\\n        \\t\\\"always\\\": [\\\"https://www.mySite.com/myWebhookReceiver\\\"]\\n        }\\n      }\\n    }\\n  }\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Response\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","excerpt":"The settings object","slug":"customer-settings","type":"basic","title":"Customer.settings"}

Customer.settings

The settings object

[block:callout] { "type": "info", "title": "Settings vs. Default Settings", "body": "When creating a Merchant Customer, you can provide a settings parameter in your request. If you choose not to provide a settings parameter in your request, the Default Settings on the Platform Customer will be created for the Merchant Customer.\n\nDefault Settings are only applicable for Platform Customers." } [/block] ## Request [block:callout] { "type": "success", "title": "Enable events!", "body": "Be sure to enabled events and provide at least one webhook event url. **Events are not enabled by default**." } [/block] [block:callout] { "type": "warning", "body": "Failure to enable events and to provide a valid webhook event url may result in missing important resource responses or updates." } [/block] [block:callout] { "type": "danger", "title": "Security Considerations", "body": "PayStand highly recommends setting all event webhook urls to be HTTPS. PayStand does not enforce this requirement but customers should be aware that failure to provide HTTPS urls does have security implications." } [/block] [block:parameters] { "data": { "h-2": "Value Format / Requirements**", "h-0": "Element", "h-1": "Specification", "h-3": "Notes", "0-0": "events.enabled", "0-1": "**Type**: Boolean\n**Example**: true\n**Description**: Set to true if events are enabled", "0-2": "true or false", "1-0": "events.urls.always", "1-3": "The url that all webhooks will always be sent to.", "0-3": "Whether or not events are to be sent. Defaults to false.", "1-1": "**Type**: Array of Url Strings\n**Format**: Array of Valid Url\n**Example**: [\"https://www.mySite.com/myWebhookReceiver\"]\n**Description**: An array of urls for events to be sent to." }, "cols": 2, "rows": 2 } [/block] ## Response All of the request parameters will be returned in the response. [block:code] { "codes": [ { "code": "{\n\t\"customer\": {\n \t\"settings\": {\n\t\t\t\"events\": {\n \"enabled\": true,\n \"urls\": {\n \t\"always\": [\"https://www.mySite.com/myWebhookReceiver\"]\n }\n }\n }\n }\n}", "language": "json", "name": "Request" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n\t\"customer\": {\n \t\"settings\": {\n\t\t\t\"events\": {\n \"enabled\": true,\n \"urls\": {\n \t\"always\": [\"https://www.mySite.com/myWebhookReceiver\"]\n }\n }\n }\n }\n}", "language": "json", "name": "Response" } ], "sidebar": true } [/block]