{"_id":"598cf16e2cbc99000fd1509e","project":"55dd0853d2d97337001800e2","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"},"category":{"_id":"5704013559c5190e000ab646","version":"55de36ec9067202b00de0015","project":"55dd0853d2d97337001800e2","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-04-05T18:17:25.419Z","from_sync":false,"order":3,"slug":"paystand-checkout-1","title":"PayStand Checkout"},"user":"57432cc3583f470e000a7784","githubsync":"","__v":0,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-08-10T23:51:10.384Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":6,"body":"Attributes can be added to the checkout script tag and HTML buttons to configure checkout. For example, here is a scheduled payment monthly checkout for $100.00, embedded, with an email passed in which will only accept cards as payment method.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<script\\n  type=\\\"text/javascript\\\"\\n  id=\\\"paystand_checkout\\\"\\n  src=\\\"https://checkout.paystand.co/v4/js/paystand.checkout.js\\\"\\n  ps-env=\\\"sandbox\\\" \\n  ps-publishable-key=\\\"1noqhele1yjgieoi8aqe4n8i\\\"\\n  ps-mode=\\\"embed\\\"\\n  ps-show=\\\"true\\\"\\n  ps-spAmount=\\\"100.00\\\"\\n  ps-spCurrency=\\\"USD\\\"\\n  ps-fixedAmount=\\\"true\\\"\\n  ps-payerEmail=\\\"email:::at:::paystand.com\\\"\\n  ps-presetName=\\\"scheduledPayment\\\"\\n  ps-spInterval=\\\"month\\\"\\n  ps-viewFunds=\\\"card\\\"\\n  ps-viewClose=\\\"hide\\\"\\n></script>\\n\",\n      \"language\": \"javascript\",\n      \"name\": \"Scheduled Payment Example using Attributes for its configuration\"\n    }\n  ]\n}\n[/block]\n\n## General Attributes\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"attribute\",\n    \"h-1\": \"details\",\n    \"h-2\": \"description\",\n    \"0-0\": \"publishableKey\",\n    \"0-1\": \"**type**: *string*\\n**elements**: init_script\\n*(required)* \",\n    \"0-2\": \"The customer's publishableKey\",\n    \"1-0\": \"containerId\",\n    \"1-1\": \"**type**: *string*\\n**example**: my_checkout_container\\n**elements**: init_script\\n*(optional)* \",\n    \"1-2\": \"An html element id, whose element checkout should be injected into.\",\n    \"2-0\": \"env\",\n    \"2-1\": \"**type**: *enum_string*\\n**enum**: sandbox|live|default\\n**default**: live\\n**elements**: init_script\\n*(optional)* \",\n    \"2-2\": \"The environment mode the checkout instance should operate in.\",\n    \"3-0\": \"debug\",\n    \"3-1\": \"**type**: *enum_string*\\n**enum**: true|false\\n**default**: false\\n**elements**: init_script\\n*(optional)* \",\n    \"3-2\": \"When set to 'true', extra logs will be output to the console.\",\n    \"4-0\": \"mode\",\n    \"5-0\": \"width\",\n    \"6-0\": \"height\",\n    \"7-0\": \"ps-click\",\n    \"4-1\": \"**type**: *enum_string*\\n**enum**: modal|embed\\n**default**: modal\\n**elements**: any\\n*(optional)* \",\n    \"5-1\": \"**type**: *string*\\n**examples**: 100px|100%\\n**default**: 400px\\n**elements**: any\\n*(optional)* \",\n    \"6-1\": \"**type**: *string*\\n**examples**: 100px|100%\\n**default**: 700px\\n**elements**: any\\n*(optional)* \",\n    \"7-1\": \"**type**: *js_string*\\n**examples**: \\\"getDetails();\\\"\\n**elements**: buttons\\n*(optional)* \",\n    \"7-2\": \"Similar to the javascript onClick event. Fires once per click. Can contain arbitrary javascript statements. The final result of the statements should be a valid checkout settings hash that will be used to configure the checkout instance.\",\n    \"6-2\": \"The height of the checkout frame.\",\n    \"5-2\": \"The width of the checkout frame.\",\n    \"4-2\": \"Whether checkout should render as a modal popup or an embedded checkout.\",\n    \"8-0\": \"drawerType\",\n    \"8-1\": \"**type**: *string* (3 values req.)\\n**examples**: open_displaced_fixed\\n**default**: closed_overlay_toggle\\n**elements**: open/closed|displaced/overlay|fixed/toggle\\n*(optional)*\",\n    \"8-2\": \"This is used to change the payor pays fee drawer in your checkout.\\n  * Open/Closed: Open **OR** close drawer.\\n  * Displaced/Overlay: In open drawer, move content down **OR **have drawer on top of content.\\n  * Fixed/Toggle: User cannot open/close drawer by clicking **OR** User can open/close drawer by clicking.\\nSupported combinations:\\n  * open_displaced_fixed\\n  * open_displaced_toggle\\n  * closed_displaced_toggle\\n  * closed_overlay_fixed\\n  * closed_overlay_toggle\"\n  },\n  \"cols\": 3,\n  \"rows\": 9\n}\n[/block]\n\n## General display attributes\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"attribute\",\n    \"h-1\": \"details\",\n    \"h-2\": \"description\",\n    \"0-0\": \"checkoutType\",\n    \"0-1\": \"**type**: *enum_string*\\n**enum**: checkout_payment|checkout_token|\\ncheckout_scheduled_payment|checkout_token2col|checkout_bank_enrollment\\n**default**: checkout_payment\\n**elements**: any\\n*(optional)*\",\n    \"0-2\": \"The type of checkout to render. The checkout type largly determines the overall type of flow the checkout will perform.\",\n    \"1-0\": \"viewFunds\",\n    \"1-1\": \"**type**: *ordered_comma_separated_enum_string *\\n**enum**: card|ach|echeck|default\\n**default**: echeck,card,ach\\n**example**: echeck,ach,card\\n**elements**: any\\n*(optional)* \",\n    \"1-2\": \"Sets the payment methods available in the checkout instance as well as the order in which they will appear.\",\n    \"2-0\": \"viewLogo\",\n    \"2-1\": \"**type**: *enum_string *\\n**enum**: hide|show|ps|default\\n**default**: ps\\n**elements**: any\\n*(optional)* \",\n    \"2-2\": \"Sets the visibility of the header logo.\",\n    \"3-0\": \"viewClose\",\n    \"3-1\": \"**type**:* enum_string*\\n**enum**: hide|show|default\\n**default**: show\\n**elements**: any\\n*(optional)* \",\n    \"3-2\": \"Set the visibility of the close button inside the checkout instance.\",\n    \"4-0\": \"viewCheckout\",\n    \"4-1\": \"**type**: *enum_string*\\n**enum**: portal-xlarge|portal-large|portal-medium|\\nportal-small|portal|mobile|default\\n**default**: mobile\\n**elements**: any\\n*(optional)* \",\n    \"4-2\": \"Set whether the checkout displays the the billing portal chrome layout or the more compact mobile layout.\",\n    \"5-0\": \"viewReceipt\",\n    \"5-1\": \"**type**: *enum_string*\\n**enum**: hide|show|close|default\\n**default**: show\\n**elements**: any\\n*(optional)* \",\n    \"5-2\": \"Set what should happen once a flow completes.\",\n    \"6-0\": \"viewLabels\",\n    \"6-1\": \"**type**: *enum_string*\\n**enum**: hide|show|default\\n**default**: show\\n**elements**: any\\n*(optional)* \",\n    \"6-2\": \"Set the visibility of field labels globally.\",\n    \"7-0\": \"viewHeader\",\n    \"7-1\": \"**type**: *enum_string*\\n**enum**: hide | show | default\\n**default**: show\\n**elements**: any\\n*(optional)*\",\n    \"7-2\": \"Set the visibility of the checkout instance header section.\",\n    \"8-0\": \"viewSecure\",\n    \"8-1\": \"**type**: *enum_string*\\n**enum**: hide|show|default\\n**default**: show\\n**elements**: any\\n*(optional)* \",\n    \"8-2\": \"Set the visibility of the security notice. This is usually the 'lock' symbol in the bottom right hand corner of the checkout instance.\",\n    \"9-0\": \"viewExtIds\",\n    \"9-1\": \"**type**: *ordered_comma_separated_enum_string *\\n**enum**: card|bank|payer\\n**default**: none\\n**example**: card,bank\\n**elements**: any\\n*(optional)* \",\n    \"9-2\": \"Set the visibility of various resource external ids.\",\n    \"12-0\": \"fixedAmount\",\n    \"12-1\": \"**type**: *boolean_string*\\n**default**: false\\n**elements**: any\\n*(optional)* \",\n    \"12-2\": \"Set the payment amount to be editable or fixed.\",\n    \"13-0\": \"customReceipt\",\n    \"13-1\": \"**type**: *html_string*\\n**elements**: any\\n*(optional)* \",\n    \"13-2\": \"Set a custom message on the receipt page.\",\n    \"14-0\": \"headerColor\",\n    \"14-1\": \"**type**: *string*\\n**elements**: any\\n*(optional)* \",\n    \"14-2\": \"Set the header color. Can be any valid css color.\",\n    \"15-0\": \"externalCss\",\n    \"15-1\": \"**type**: *css_url_string*\\n**elements**: any\\n*(optional)* \",\n    \"15-2\": \"Load an external css file to alter the look and feel of the checkout instance.\",\n    \"16-0\": \"logoUrl\",\n    \"16-1\": \"**type**: image_url_string\\n**elements**: any\\n(optional)\",\n    \"16-2\": \"Load an external image url to display as the header logo.\",\n    \"11-0\": \"viewSupportInfo\",\n    \"11-1\": \"**type**: *boolean_string*\\n**default**: true\\n**elements**: any\\n*(optional)*\",\n    \"11-2\": \"Set the visibility of the PayStand support content in the portal view's footer.\",\n    \"10-0\": \"viewPoweredBy\",\n    \"10-1\": \"**type**: *boolean_string*\\n**default**: true\\n**elements**: any\\n*(optional)*\",\n    \"10-2\": \"Set the visibility of the \\\"Powered by: PayStand\\\" logo in the portal view's footer.\"\n  },\n  \"cols\": 3,\n  \"rows\": 17\n}\n[/block]\n\n## Resource attributes\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"cardExtId\",\n    \"0-1\": \"**type**: *string*\\n**elements**: any\\n*(optional)* \",\n    \"0-2\": \"The card external id.\",\n    \"1-0\": \"cardMeta\",\n    \"1-1\": \"**type**: *json_string*\\n**elements**: any\\n*(optional)* \",\n    \"1-2\": \"The card meta data.\",\n    \"2-0\": \"cardAddressStreet\",\n    \"2-1\": \"**type**: *string*\\n**elements**: any\\n*(optional)* \",\n    \"2-2\": \"The card street address.\",\n    \"3-0\": \"cardAddressCity\",\n    \"3-1\": \"**type**: *string*\\n**elements**: any\\n*(optional)* \",\n    \"3-2\": \"The card city address.\",\n    \"4-0\": \"cardAddressPostal\",\n    \"4-1\": \"**type**: *string*\\n**elements**: any\\n*(optional)* \",\n    \"4-2\": \"The card postal address.\",\n    \"5-0\": \"cardAddressState\",\n    \"5-1\": \"**type**: *string*\\n**elements**: any\\n*(optional)* \",\n    \"5-2\": \"The card state address.\",\n    \"6-0\": \"cardAddressCountry\",\n    \"6-1\": \"**type**: *string*\\n**elements**: any\\n*(optional)* \",\n    \"6-2\": \"The card country address.\",\n    \"7-0\": \"bankNameOnAccount\",\n    \"7-1\": \"**type**: *string*\\n**elements**: any\\n*(optional)* \",\n    \"7-2\": \"The name on the bank account.\",\n    \"8-0\": \"bankAccountType\",\n    \"8-1\": \"**type**: *enum_string*\\n**enum**: checking|savings\\n**elements**: any\\n*(optional)* \",\n    \"8-2\": \"The bank account type.\",\n    \"9-0\": \"bankAccountHolderType\",\n    \"9-1\": \"**type**: *enum_string*\\n**enum**: individual|corporate\\n**elements**: any\\n*(optional)* \",\n    \"9-2\": \"The bank account holder type.\",\n    \"10-0\": \"bankRouting\",\n    \"10-1\": \"**type**: *string*\\n**elements**: any\\n*(optional)* \",\n    \"10-2\": \"The bank routing number.\",\n    \"11-0\": \"bankAccount\",\n    \"11-1\": \"**type**: *string*\\n**elements**: any\\n*(optional)* \",\n    \"11-2\": \"The bank account number.\",\n    \"12-0\": \"bankAccountRepeat\",\n    \"12-1\": \"**type**: *string*\\n**elements**: any\\n*(optional)* \",\n    \"12-2\": \"The bank account repeat number.\",\n    \"13-0\": \"bankExtId\",\n    \"13-1\": \"**type**: *string*\\n**elements**: any\\n*(optional)* \",\n    \"13-2\": \"The bank external id.\",\n    \"14-0\": \"bankMeta\",\n    \"14-1\": \"**type**: *json_string*\\n**elements**: any\\n*(optional)* \",\n    \"14-2\": \"The bank meta data.\",\n    \"15-0\": \"bankAddressStreet\",\n    \"15-1\": \"**type**: *string*\\n**elements**: any\\n*(optional)* \",\n    \"15-2\": \"The bank street address.\",\n    \"16-0\": \"bankAddressCity\",\n    \"16-1\": \"**type**: *string*\\n**elements**: any\\n*(optional)\\t* \",\n    \"16-2\": \"The bank city address.\",\n    \"17-0\": \"bankAddressPostal\",\n    \"17-1\": \"**type**: *string*\\n**elements**: any\\n*(optional)* \",\n    \"17-2\": \"The bank postal address.\",\n    \"18-0\": \"bankAddressState\",\n    \"18-1\": \"**type**: *string*\\n**elements**: any\\n*(optional)* \",\n    \"18-2\": \"The bank state address.\",\n    \"19-0\": \"bankAddressCountry\",\n    \"19-1\": \"**type**: *string*\\n**elements**: any\\n*(optional)* \",\n    \"19-2\": \"The bank country address.\",\n    \"20-0\": \"payerName\",\n    \"20-1\": \"**type**: *string*\\n**elements**: any\\n*(optional)* \",\n    \"20-2\": \"The payer name.\",\n    \"21-0\": \"payerEmail\",\n    \"21-1\": \"**type**: *string*\\n**elements**: any\\n*(optional)*\",\n    \"21-2\": \"The payer email.\",\n    \"22-0\": \"payerExtId\",\n    \"22-1\": \"**type**: *string*\\n**elements**: any\\n*(optional)* \",\n    \"22-2\": \"The payer external id.\",\n    \"23-0\": \"payerMeta\",\n    \"23-1\": \"**type**: *json_string*\\n**elements**: any\\n*(optional)* \",\n    \"23-2\": \"The payer meta data.\",\n    \"24-0\": \"payerAddressStreet\",\n    \"24-1\": \"**type**: *string*\\n**elements**: any\\n*(optional)* \",\n    \"24-2\": \"The payer street address.\",\n    \"25-0\": \"payerAddressCity\",\n    \"25-1\": \"**type**: *string*\\n**elements**: any\\n*(optional)* \",\n    \"25-2\": \"The payer city address.\",\n    \"26-0\": \"payerAddressPostal\",\n    \"26-1\": \"**type**: *string*\\n**elements**: any\\n*(optional)* \",\n    \"26-2\": \"The payer postal address.\",\n    \"27-0\": \"payerAddressState\",\n    \"27-1\": \"**type**: *string*\\n**elements**: any\\n*(optional)* \",\n    \"27-2\": \"The payer state address.\",\n    \"28-0\": \"payerAddressCountry\",\n    \"28-1\": \"**type**: *string*\\n**elements**: any\\n*(optional)* \",\n    \"28-2\": \"The payer country address.\",\n    \"29-0\": \"paymentAmount\",\n    \"29-1\": \"**type**: *string*\\n**elements**: any\\n*(optional)* \",\n    \"29-2\": \"The payment amount.\",\n    \"30-0\": \"paymentCurrency\",\n    \"30-1\": \"**type**: *string*\\n**elements**: any\\n*(optional)* \",\n    \"30-2\": \"The payment currency.\",\n    \"31-0\": \"paymentDescription\",\n    \"31-1\": \"**type**: *string*\\n**elements**: any\\n*(optional)* \",\n    \"31-2\": \"The payment description.\",\n    \"32-0\": \"paymentExtId\",\n    \"32-1\": \"**type**: *string*\\n**elements**: any\\n*(optional)* \",\n    \"32-2\": \"The payment external id.\",\n    \"33-0\": \"paymentMeta\",\n    \"33-1\": \"**type**: *json_string*\\n**elements**: any\\n*(optional)* \",\n    \"33-2\": \"The payment meta.\",\n    \"34-0\": \"spName\",\n    \"34-1\": \"**type**:* string*\\n**elements**: any\\n*(optional)* \",\n    \"34-2\": \"The scheduled payment name.\",\n    \"35-0\": \"spDescription\",\n    \"35-1\": \"**type**: *string*\\n**elements**: any\\n*(optional)* \",\n    \"35-2\": \"The scheduled payment description.\",\n    \"36-0\": \"spExtId\",\n    \"36-1\": \"**type**: *string*\\n**elements**: any\\n*(optional)* \",\n    \"36-2\": \"The scheduled payment external id.\",\n    \"37-0\": \"spMeta\",\n    \"37-1\": \"**type**: *json_string*\\n**elements**: any\\n*(optional)* \",\n    \"37-2\": \"The scheduled payment meta data.\",\n    \"38-0\": \"spAmount\",\n    \"38-1\": \"**type**: * integer_string*\\n**elements**: any\\n*(optional)*\",\n    \"38-2\": \"The scheduled payment amount.\",\n    \"39-0\": \"spCurrency\",\n    \"39-1\": \"**type**: *enum_string*\\n**elements**: any\\n**default**: USD\\n*(optional)*\",\n    \"39-2\": \"The scheduled payment currency.\",\n    \"40-0\": \"spInterval\",\n    \"40-1\": \"**type**: *enum_string*\\n**enum**: week|month|year|day\\n**elements**: any\\n**default**: week\\n*(optional)*\",\n    \"40-2\": \"The scheduled payment interval.\",\n    \"41-0\": \"spIntervalCount\",\n    \"41-1\": \"**type**: *integer_string*\\n**elements**: any\\n*(optional)* \",\n    \"41-2\": \"The scheduled payment interval count.\",\n    \"42-0\": \"spAnchor\",\n    \"42-1\": \"**type**: *enum_string*\\n**enum**: start|end\\nelements: any\\n*(optional)*\",\n    \"42-2\": \"The scheduled payment anchor.\",\n    \"43-0\": \"spTimesToRun\",\n    \"43-1\": \"**type**:* integer_string*\\n**elements**: any\\n*(optional)* \",\n    \"43-2\": \"The scheduled payment times to run.\",\n    \"44-0\": \"spAtDay\",\n    \"44-1\": \"**type**:* integer_string*\\n**elements**: any\\n*(optional)* \",\n    \"44-2\": \"The scheduled payment day to run.\",\n    \"45-0\": \"cf_*\",\n    \"45-1\": \"*: any valid custom field key\\n**type**: *string*\\n**elements**: any\\n*(optional)* \",\n    \"45-2\": \"Custom field resource data. If a custom field has a key such as someCustomFieldKey, then the attribute should be cf_some_custom_field_key.\"\n  },\n  \"cols\": 3,\n  \"rows\": 46\n}\n[/block]\n\n## Resource display attributes\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"showHeader_*\",\n    \"0-1\": \"\\\\*: cardHeader | bankHeader | payerHeader\\n**type**: *enum_string*\\n**enum**: hide|show|default\\n**default**: show\\n**elements**: any\\n*(optional)\\t*\",\n    \"0-2\": \"Set the visibility of a section header.\",\n    \"1-0\": \"setHeader_*\",\n    \"1-1\": \"\\\\*: cardHeader | bankHeader | payerHeader\\n**type**: *string*\\n**elements**: any\\n*(optional)*\",\n    \"1-2\": \"Set the text for a section header.\",\n    \"2-0\": \"showField_*\",\n    \"2-1\": \"\\\\*: any card, bank, or payer resource field above\\n**type**: *enum_string*\\n**enum**: hide|show|default\\n**default**: varies\\n**elements**: any\\n*(optional)*\",\n    \"2-2\": \"Set the visibility of a field.\",\n    \"3-0\": \"showFieldIcon_*\",\n    \"3-1\": \"\\\\*: any card, bank, or payer resource field above\\n**type**: *enum_string*\\n**enum**: hide|show|default\\n**default**: varies\\n**elements**: any\\n*(optional)*\",\n    \"3-2\": \"Set the visibility of a field's icon.\",\n    \"4-0\": \"setPlaceholder_*\",\n    \"4-1\": \"\\\\*: any card, bank, or payer resource field above\\n**type**: *string*\\n**elements**: any\\n*(optional)*\",\n    \"4-2\": \"Set the placeholder text for a field.\",\n    \"5-0\": \"setFieldIcon_*\",\n    \"5-1\": \"\\\\*: any card, bank, or payer resource field above\\n**type**: *material_icon_string*\\n**elements**: any\\n*(optional)\\t*\",\n    \"5-2\": \"Set a fields icon.\",\n    \"6-0\": \"setLabel_*\",\n    \"6-1\": \"\\\\*: any card, bank, or payer resource field above\\n**type**: *string*\\n**elements**: any\\n*(optional)\\t*\",\n    \"6-2\": \"Set a field's label.\",\n    \"7-0\": \"setLayout_fundSelect\",\n    \"7-1\": \"**type**: *enum_string*\\n**enum**: tabs|buttons\\n**elements**: any\\n*(optional)* \",\n    \"7-2\": \"Set the layout for the payment method select buttons/tabs.\",\n    \"8-0\": \"setFundSelector_cardTabText\",\n    \"8-1\": \"**type**: *string*\\nb: any\\n*(optional)*\",\n    \"8-2\": \"Set the card payment method selector text.\",\n    \"9-0\": \"setFundSelector_bankTabText\",\n    \"9-1\": \"**type**: *string*\\n**elements**: any\\n*(optional)\\t* \",\n    \"9-2\": \"Set the ach payment method selector text.\",\n    \"10-0\": \"setFundSelector_bankSessionTabText\",\n    \"10-1\": \"**type**: *string*\\n**elements**: any\\n*(optional)* \",\n    \"10-2\": \"Set the echeck payment method selector text.\"\n  },\n  \"cols\": 3,\n  \"rows\": 11\n}\n[/block]","excerpt":"A list of all the allowed attributes in checkout.","slug":"checkout-attributes","type":"basic","title":"Checkout Attributes"}

Checkout Attributes

A list of all the allowed attributes in checkout.

Attributes can be added to the checkout script tag and HTML buttons to configure checkout. For example, here is a scheduled payment monthly checkout for $100.00, embedded, with an email passed in which will only accept cards as payment method. [block:code] { "codes": [ { "code": "<script\n type=\"text/javascript\"\n id=\"paystand_checkout\"\n src=\"https://checkout.paystand.co/v4/js/paystand.checkout.js\"\n ps-env=\"sandbox\" \n ps-publishable-key=\"1noqhele1yjgieoi8aqe4n8i\"\n ps-mode=\"embed\"\n ps-show=\"true\"\n ps-spAmount=\"100.00\"\n ps-spCurrency=\"USD\"\n ps-fixedAmount=\"true\"\n ps-payerEmail=\"email@paystand.com\"\n ps-presetName=\"scheduledPayment\"\n ps-spInterval=\"month\"\n ps-viewFunds=\"card\"\n ps-viewClose=\"hide\"\n></script>\n", "language": "javascript", "name": "Scheduled Payment Example using Attributes for its configuration" } ] } [/block] ## General Attributes [block:parameters] { "data": { "h-0": "attribute", "h-1": "details", "h-2": "description", "0-0": "publishableKey", "0-1": "**type**: *string*\n**elements**: init_script\n*(required)* ", "0-2": "The customer's publishableKey", "1-0": "containerId", "1-1": "**type**: *string*\n**example**: my_checkout_container\n**elements**: init_script\n*(optional)* ", "1-2": "An html element id, whose element checkout should be injected into.", "2-0": "env", "2-1": "**type**: *enum_string*\n**enum**: sandbox|live|default\n**default**: live\n**elements**: init_script\n*(optional)* ", "2-2": "The environment mode the checkout instance should operate in.", "3-0": "debug", "3-1": "**type**: *enum_string*\n**enum**: true|false\n**default**: false\n**elements**: init_script\n*(optional)* ", "3-2": "When set to 'true', extra logs will be output to the console.", "4-0": "mode", "5-0": "width", "6-0": "height", "7-0": "ps-click", "4-1": "**type**: *enum_string*\n**enum**: modal|embed\n**default**: modal\n**elements**: any\n*(optional)* ", "5-1": "**type**: *string*\n**examples**: 100px|100%\n**default**: 400px\n**elements**: any\n*(optional)* ", "6-1": "**type**: *string*\n**examples**: 100px|100%\n**default**: 700px\n**elements**: any\n*(optional)* ", "7-1": "**type**: *js_string*\n**examples**: \"getDetails();\"\n**elements**: buttons\n*(optional)* ", "7-2": "Similar to the javascript onClick event. Fires once per click. Can contain arbitrary javascript statements. The final result of the statements should be a valid checkout settings hash that will be used to configure the checkout instance.", "6-2": "The height of the checkout frame.", "5-2": "The width of the checkout frame.", "4-2": "Whether checkout should render as a modal popup or an embedded checkout.", "8-0": "drawerType", "8-1": "**type**: *string* (3 values req.)\n**examples**: open_displaced_fixed\n**default**: closed_overlay_toggle\n**elements**: open/closed|displaced/overlay|fixed/toggle\n*(optional)*", "8-2": "This is used to change the payor pays fee drawer in your checkout.\n * Open/Closed: Open **OR** close drawer.\n * Displaced/Overlay: In open drawer, move content down **OR **have drawer on top of content.\n * Fixed/Toggle: User cannot open/close drawer by clicking **OR** User can open/close drawer by clicking.\nSupported combinations:\n * open_displaced_fixed\n * open_displaced_toggle\n * closed_displaced_toggle\n * closed_overlay_fixed\n * closed_overlay_toggle" }, "cols": 3, "rows": 9 } [/block] ## General display attributes [block:parameters] { "data": { "h-0": "attribute", "h-1": "details", "h-2": "description", "0-0": "checkoutType", "0-1": "**type**: *enum_string*\n**enum**: checkout_payment|checkout_token|\ncheckout_scheduled_payment|checkout_token2col|checkout_bank_enrollment\n**default**: checkout_payment\n**elements**: any\n*(optional)*", "0-2": "The type of checkout to render. The checkout type largly determines the overall type of flow the checkout will perform.", "1-0": "viewFunds", "1-1": "**type**: *ordered_comma_separated_enum_string *\n**enum**: card|ach|echeck|default\n**default**: echeck,card,ach\n**example**: echeck,ach,card\n**elements**: any\n*(optional)* ", "1-2": "Sets the payment methods available in the checkout instance as well as the order in which they will appear.", "2-0": "viewLogo", "2-1": "**type**: *enum_string *\n**enum**: hide|show|ps|default\n**default**: ps\n**elements**: any\n*(optional)* ", "2-2": "Sets the visibility of the header logo.", "3-0": "viewClose", "3-1": "**type**:* enum_string*\n**enum**: hide|show|default\n**default**: show\n**elements**: any\n*(optional)* ", "3-2": "Set the visibility of the close button inside the checkout instance.", "4-0": "viewCheckout", "4-1": "**type**: *enum_string*\n**enum**: portal-xlarge|portal-large|portal-medium|\nportal-small|portal|mobile|default\n**default**: mobile\n**elements**: any\n*(optional)* ", "4-2": "Set whether the checkout displays the the billing portal chrome layout or the more compact mobile layout.", "5-0": "viewReceipt", "5-1": "**type**: *enum_string*\n**enum**: hide|show|close|default\n**default**: show\n**elements**: any\n*(optional)* ", "5-2": "Set what should happen once a flow completes.", "6-0": "viewLabels", "6-1": "**type**: *enum_string*\n**enum**: hide|show|default\n**default**: show\n**elements**: any\n*(optional)* ", "6-2": "Set the visibility of field labels globally.", "7-0": "viewHeader", "7-1": "**type**: *enum_string*\n**enum**: hide | show | default\n**default**: show\n**elements**: any\n*(optional)*", "7-2": "Set the visibility of the checkout instance header section.", "8-0": "viewSecure", "8-1": "**type**: *enum_string*\n**enum**: hide|show|default\n**default**: show\n**elements**: any\n*(optional)* ", "8-2": "Set the visibility of the security notice. This is usually the 'lock' symbol in the bottom right hand corner of the checkout instance.", "9-0": "viewExtIds", "9-1": "**type**: *ordered_comma_separated_enum_string *\n**enum**: card|bank|payer\n**default**: none\n**example**: card,bank\n**elements**: any\n*(optional)* ", "9-2": "Set the visibility of various resource external ids.", "12-0": "fixedAmount", "12-1": "**type**: *boolean_string*\n**default**: false\n**elements**: any\n*(optional)* ", "12-2": "Set the payment amount to be editable or fixed.", "13-0": "customReceipt", "13-1": "**type**: *html_string*\n**elements**: any\n*(optional)* ", "13-2": "Set a custom message on the receipt page.", "14-0": "headerColor", "14-1": "**type**: *string*\n**elements**: any\n*(optional)* ", "14-2": "Set the header color. Can be any valid css color.", "15-0": "externalCss", "15-1": "**type**: *css_url_string*\n**elements**: any\n*(optional)* ", "15-2": "Load an external css file to alter the look and feel of the checkout instance.", "16-0": "logoUrl", "16-1": "**type**: image_url_string\n**elements**: any\n(optional)", "16-2": "Load an external image url to display as the header logo.", "11-0": "viewSupportInfo", "11-1": "**type**: *boolean_string*\n**default**: true\n**elements**: any\n*(optional)*", "11-2": "Set the visibility of the PayStand support content in the portal view's footer.", "10-0": "viewPoweredBy", "10-1": "**type**: *boolean_string*\n**default**: true\n**elements**: any\n*(optional)*", "10-2": "Set the visibility of the \"Powered by: PayStand\" logo in the portal view's footer." }, "cols": 3, "rows": 17 } [/block] ## Resource attributes [block:parameters] { "data": { "0-0": "cardExtId", "0-1": "**type**: *string*\n**elements**: any\n*(optional)* ", "0-2": "The card external id.", "1-0": "cardMeta", "1-1": "**type**: *json_string*\n**elements**: any\n*(optional)* ", "1-2": "The card meta data.", "2-0": "cardAddressStreet", "2-1": "**type**: *string*\n**elements**: any\n*(optional)* ", "2-2": "The card street address.", "3-0": "cardAddressCity", "3-1": "**type**: *string*\n**elements**: any\n*(optional)* ", "3-2": "The card city address.", "4-0": "cardAddressPostal", "4-1": "**type**: *string*\n**elements**: any\n*(optional)* ", "4-2": "The card postal address.", "5-0": "cardAddressState", "5-1": "**type**: *string*\n**elements**: any\n*(optional)* ", "5-2": "The card state address.", "6-0": "cardAddressCountry", "6-1": "**type**: *string*\n**elements**: any\n*(optional)* ", "6-2": "The card country address.", "7-0": "bankNameOnAccount", "7-1": "**type**: *string*\n**elements**: any\n*(optional)* ", "7-2": "The name on the bank account.", "8-0": "bankAccountType", "8-1": "**type**: *enum_string*\n**enum**: checking|savings\n**elements**: any\n*(optional)* ", "8-2": "The bank account type.", "9-0": "bankAccountHolderType", "9-1": "**type**: *enum_string*\n**enum**: individual|corporate\n**elements**: any\n*(optional)* ", "9-2": "The bank account holder type.", "10-0": "bankRouting", "10-1": "**type**: *string*\n**elements**: any\n*(optional)* ", "10-2": "The bank routing number.", "11-0": "bankAccount", "11-1": "**type**: *string*\n**elements**: any\n*(optional)* ", "11-2": "The bank account number.", "12-0": "bankAccountRepeat", "12-1": "**type**: *string*\n**elements**: any\n*(optional)* ", "12-2": "The bank account repeat number.", "13-0": "bankExtId", "13-1": "**type**: *string*\n**elements**: any\n*(optional)* ", "13-2": "The bank external id.", "14-0": "bankMeta", "14-1": "**type**: *json_string*\n**elements**: any\n*(optional)* ", "14-2": "The bank meta data.", "15-0": "bankAddressStreet", "15-1": "**type**: *string*\n**elements**: any\n*(optional)* ", "15-2": "The bank street address.", "16-0": "bankAddressCity", "16-1": "**type**: *string*\n**elements**: any\n*(optional)\t* ", "16-2": "The bank city address.", "17-0": "bankAddressPostal", "17-1": "**type**: *string*\n**elements**: any\n*(optional)* ", "17-2": "The bank postal address.", "18-0": "bankAddressState", "18-1": "**type**: *string*\n**elements**: any\n*(optional)* ", "18-2": "The bank state address.", "19-0": "bankAddressCountry", "19-1": "**type**: *string*\n**elements**: any\n*(optional)* ", "19-2": "The bank country address.", "20-0": "payerName", "20-1": "**type**: *string*\n**elements**: any\n*(optional)* ", "20-2": "The payer name.", "21-0": "payerEmail", "21-1": "**type**: *string*\n**elements**: any\n*(optional)*", "21-2": "The payer email.", "22-0": "payerExtId", "22-1": "**type**: *string*\n**elements**: any\n*(optional)* ", "22-2": "The payer external id.", "23-0": "payerMeta", "23-1": "**type**: *json_string*\n**elements**: any\n*(optional)* ", "23-2": "The payer meta data.", "24-0": "payerAddressStreet", "24-1": "**type**: *string*\n**elements**: any\n*(optional)* ", "24-2": "The payer street address.", "25-0": "payerAddressCity", "25-1": "**type**: *string*\n**elements**: any\n*(optional)* ", "25-2": "The payer city address.", "26-0": "payerAddressPostal", "26-1": "**type**: *string*\n**elements**: any\n*(optional)* ", "26-2": "The payer postal address.", "27-0": "payerAddressState", "27-1": "**type**: *string*\n**elements**: any\n*(optional)* ", "27-2": "The payer state address.", "28-0": "payerAddressCountry", "28-1": "**type**: *string*\n**elements**: any\n*(optional)* ", "28-2": "The payer country address.", "29-0": "paymentAmount", "29-1": "**type**: *string*\n**elements**: any\n*(optional)* ", "29-2": "The payment amount.", "30-0": "paymentCurrency", "30-1": "**type**: *string*\n**elements**: any\n*(optional)* ", "30-2": "The payment currency.", "31-0": "paymentDescription", "31-1": "**type**: *string*\n**elements**: any\n*(optional)* ", "31-2": "The payment description.", "32-0": "paymentExtId", "32-1": "**type**: *string*\n**elements**: any\n*(optional)* ", "32-2": "The payment external id.", "33-0": "paymentMeta", "33-1": "**type**: *json_string*\n**elements**: any\n*(optional)* ", "33-2": "The payment meta.", "34-0": "spName", "34-1": "**type**:* string*\n**elements**: any\n*(optional)* ", "34-2": "The scheduled payment name.", "35-0": "spDescription", "35-1": "**type**: *string*\n**elements**: any\n*(optional)* ", "35-2": "The scheduled payment description.", "36-0": "spExtId", "36-1": "**type**: *string*\n**elements**: any\n*(optional)* ", "36-2": "The scheduled payment external id.", "37-0": "spMeta", "37-1": "**type**: *json_string*\n**elements**: any\n*(optional)* ", "37-2": "The scheduled payment meta data.", "38-0": "spAmount", "38-1": "**type**: * integer_string*\n**elements**: any\n*(optional)*", "38-2": "The scheduled payment amount.", "39-0": "spCurrency", "39-1": "**type**: *enum_string*\n**elements**: any\n**default**: USD\n*(optional)*", "39-2": "The scheduled payment currency.", "40-0": "spInterval", "40-1": "**type**: *enum_string*\n**enum**: week|month|year|day\n**elements**: any\n**default**: week\n*(optional)*", "40-2": "The scheduled payment interval.", "41-0": "spIntervalCount", "41-1": "**type**: *integer_string*\n**elements**: any\n*(optional)* ", "41-2": "The scheduled payment interval count.", "42-0": "spAnchor", "42-1": "**type**: *enum_string*\n**enum**: start|end\nelements: any\n*(optional)*", "42-2": "The scheduled payment anchor.", "43-0": "spTimesToRun", "43-1": "**type**:* integer_string*\n**elements**: any\n*(optional)* ", "43-2": "The scheduled payment times to run.", "44-0": "spAtDay", "44-1": "**type**:* integer_string*\n**elements**: any\n*(optional)* ", "44-2": "The scheduled payment day to run.", "45-0": "cf_*", "45-1": "*: any valid custom field key\n**type**: *string*\n**elements**: any\n*(optional)* ", "45-2": "Custom field resource data. If a custom field has a key such as someCustomFieldKey, then the attribute should be cf_some_custom_field_key." }, "cols": 3, "rows": 46 } [/block] ## Resource display attributes [block:parameters] { "data": { "0-0": "showHeader_*", "0-1": "\\*: cardHeader | bankHeader | payerHeader\n**type**: *enum_string*\n**enum**: hide|show|default\n**default**: show\n**elements**: any\n*(optional)\t*", "0-2": "Set the visibility of a section header.", "1-0": "setHeader_*", "1-1": "\\*: cardHeader | bankHeader | payerHeader\n**type**: *string*\n**elements**: any\n*(optional)*", "1-2": "Set the text for a section header.", "2-0": "showField_*", "2-1": "\\*: any card, bank, or payer resource field above\n**type**: *enum_string*\n**enum**: hide|show|default\n**default**: varies\n**elements**: any\n*(optional)*", "2-2": "Set the visibility of a field.", "3-0": "showFieldIcon_*", "3-1": "\\*: any card, bank, or payer resource field above\n**type**: *enum_string*\n**enum**: hide|show|default\n**default**: varies\n**elements**: any\n*(optional)*", "3-2": "Set the visibility of a field's icon.", "4-0": "setPlaceholder_*", "4-1": "\\*: any card, bank, or payer resource field above\n**type**: *string*\n**elements**: any\n*(optional)*", "4-2": "Set the placeholder text for a field.", "5-0": "setFieldIcon_*", "5-1": "\\*: any card, bank, or payer resource field above\n**type**: *material_icon_string*\n**elements**: any\n*(optional)\t*", "5-2": "Set a fields icon.", "6-0": "setLabel_*", "6-1": "\\*: any card, bank, or payer resource field above\n**type**: *string*\n**elements**: any\n*(optional)\t*", "6-2": "Set a field's label.", "7-0": "setLayout_fundSelect", "7-1": "**type**: *enum_string*\n**enum**: tabs|buttons\n**elements**: any\n*(optional)* ", "7-2": "Set the layout for the payment method select buttons/tabs.", "8-0": "setFundSelector_cardTabText", "8-1": "**type**: *string*\nb: any\n*(optional)*", "8-2": "Set the card payment method selector text.", "9-0": "setFundSelector_bankTabText", "9-1": "**type**: *string*\n**elements**: any\n*(optional)\t* ", "9-2": "Set the ach payment method selector text.", "10-0": "setFundSelector_bankSessionTabText", "10-1": "**type**: *string*\n**elements**: any\n*(optional)* ", "10-2": "Set the echeck payment method selector text." }, "cols": 3, "rows": 11 } [/block]