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.
<script
type="text/javascript"
id="paystand_checkout"
src="https://checkout.paystand.co/v4/js/paystand.checkout.js"
ps-env="sandbox"
ps-publishableKey="1noqhele1yjgieoi8aqe4n8i"
ps-mode="embed"
ps-show="true"
ps-spAmount="100.00"
ps-spCurrency="USD"
ps-fixedAmount="true"
ps-payerEmail="[email protected]"
ps-checkoutType="checkout_scheduled_payment"
ps-spInterval="month"
ps-viewFunds="card"
ps-viewClose="hide"
></script>
General Attributes
attribute | details | description |
|---|---|---|
publishableKey | type: string | The customer's publishableKey |
containerId | type: string | An html element id, whose element checkout should be injected into. |
env | type: enum_string | The environment mode the checkout instance should operate in. |
debug | type: enum_string | When set to 'true', extra logs will be output to the console. |
mode | type: enum_string | Whether checkout should render as a modal popup or an embedded checkout. |
width | type: string | The width of the checkout frame. |
height | type: string | The height of the checkout frame. |
ps-click | type: js_string | 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. |
drawerType | type: string (3 values req.) | This is used to change the payor pays fee drawer in your checkout.
|
General display attributes
attribute | details | description |
|---|---|---|
checkoutType | type: enum_string | The type of checkout to render. The checkout type largly determines the overall type of flow the checkout will perform. |
viewFunds | type: ordered_comma_separated_enum_string | Sets the payment methods available in the checkout instance as well as the order in which they will appear. |
viewLogo | type: enum_string | Sets the visibility of the header logo. |
viewClose | type: enum_string | Set the visibility of the close button inside the checkout instance. |
viewCheckout | type: enum_string | Set whether the checkout displays the the billing portal chrome layout or the more compact mobile layout. |
viewReceipt | type: enum_string | Set what should happen once a flow completes. |
viewLabels | type: enum_string | Set the visibility of field labels globally. |
viewHeader | type:** enum_string | Set the visibility of the checkout instance header section. |
viewSecure | type: enum_string | Set the visibility of the security notice. This is usually the 'lock' symbol in the bottom right hand corner of the checkout instance. |
viewExtIds | type: ordered_comma_separated_enum_string | Set the visibility of various resource external ids. |
hidePoweredBy | type: boolean_string | Set the visibility of the "Powered by: Paystand" logo in the portal view's footer. |
hideSupportInfo | type: boolean_string | Set the visibility of the Paystand support content in the portal view's footer. |
fixedAmount | type: boolean_string | Set the payment amount to be editable or fixed. |
customReceipt | type: html_string | Set a custom message on the receipt page. |
headerColor | type: string | Set the header color. Can be any valid css color. |
externalCss | type: css_url_string | Load an external css file to alter the look and feel of the checkout instance. |
logoUrl | type: image_url_string | Load an external image url to display as the header logo. |
hideCf | type:string | Comma separated list of custom field keys. Hide custom fields that have been enabled in the dashboard or per billing portal. |
checkoutDescription | type: string | Description displayed in the checkout header section. |
Resource attributes
cardExtId | type: string | The card external id. |
|---|---|---|
cardMeta | type: json_string | The card meta data. |
cardAddressStreet | type: string | The card street address. |
cardAddressCity | type: string | The card city address. |
cardAddressPostal | type: string | The card postal address. |
cardAddressState | type: string | The card state address. |
cardAddressCountry | type: string | The card country address. |
bankNameOnAccount | type: string | The name on the bank account. |
bankAccountType | type: enum_string | The bank account type. |
bankAccountHolderType | type: enum_string | The bank account holder type. |
bankRouting | type: string | The bank routing number. |
bankAccount | type: string | The bank account number. |
bankAccountRepeat | type: string | The bank account repeat number. |
bankExtId | type: string | The bank external id. |
bankMeta | type: json_string | The bank meta data. |
bankAddressStreet | type: string | The bank street address. |
bankAddressCity | type: string | The bank city address. |
bankAddressPostal | type: string | The bank postal address. |
bankAddressState | type: string | The bank state address. |
bankAddressCountry | type: string | The bank country address. |
payerName | type: string | The payer name. |
payerEmail | type: string | The payer email. |
payerId | type: string | The payer id. |
payerExtId | type: string | The payer external id. |
payerMeta | type: json_string | The payer meta data. |
payerAddressStreet | type: string | The payer street address. |
payerAddressCity | type: string | The payer city address. |
payerAddressPostal | type: string | The payer postal address. |
payerAddressState | type: string | The payer state address. |
payerAddressCountry | type: string | The payer country address. |
paymentAmount | type: string | The payment amount. |
paymentCurrency | type: string | The payment currency. Supported currencies [ "USD", "CAD", "EUR", "MXN", "AUD", "GBP" ] |
paymentDescription | type: string | The payment description. |
paymentExtId | type: string | The payment external id. |
paymentMeta | type: json_string | The payment meta. |
spName | type: string | The scheduled payment name. |
spDescription | type: string | The scheduled payment description. |
spExtId | type: string | The scheduled payment external id. |
spMeta | type: json_string | The scheduled payment meta data. |
spAmount | type: integer_string | The scheduled payment amount. |
spCurrency | type: enum_string | The scheduled payment currency. |
spInterval | type: enum_string | The scheduled payment interval. |
spIntervalCount | type: integer_string | The scheduled payment interval count. |
spAnchor | type: enum_string | The scheduled payment anchor. |
spTimesToRun | type: integer_string | The scheduled payment times to run. |
spAtDay | type: integer_string | The scheduled payment day to run. |
cf_* | : any valid custom field key | Custom field resource data. If a custom field has a key such as someCustomFieldKey, then the attribute should be cf_some_custom_field_key. |
Resource display attributes
showHeader_* | *: cardHeader | bankHeader | payerHeader | Set the visibility of a section header. |
|---|---|---|
setHeader_* | *: cardHeader | bankHeader | payerHeader | Set the text for a section header. |
showField_* | *: any card, bank, or payer resource field above | Set the visibility of a field. |
showFieldIcon_* | *: any card, bank, or payer resource field above | Set the visibility of a field's icon. |
setPlaceholder_* | *: any card, bank, or payer resource field above | Set the placeholder text for a field. |
setFieldIcon_* | *: any card, bank, or payer resource field above | Set a fields icon. |
setLabel_* | *: any card, bank, or payer resource field above | Set a field's label. |
setLayout_fundSelect | type: enum_string | Set the layout for the payment method select buttons/tabs. |
setFundSelector_cardTabText | type: string | Set the card payment method selector text. |
setFundSelector_bankTabText | type: string | Set the ach payment method selector text. |
setFundSelector_bankSessionTabText | type: string | Set the echeck payment method selector text. |
Behavior Attributes
disableFees | type:boolean | Disable any additional fees for all payment rails (if you have it enabled in the dashboard). |
|---|---|---|
disableNetworkFees | type:boolean | Disable any additional fees for Paystand Bank Network payments (if you have it enabled in the dashboard). |
disableBankFees | type:boolean | Disable any additional fees for ACH payments (if you have it enabled in the dashboard). |
disableCardFees | type:boolean | Disable any additional fees for card payments (if you have it enabled in the dashboard). |