Abbreviations can be added to the checkout url to pass various configuration parameters to render checkout in its own (portal) webpage. For example, here is a basic checkout for $1.00, set with the value "p.a=1". This is useful for integration that do not support embedding JavaScript code such as an HTML email, PDF invoices, or integrations with certain third party services.
https://checkout.paystand.co/v4/?a.k=5csyxqnc417ao15u24p93fo0&r.p.a=1.00&r.p.u=USD
Type | Parameter | Description | Abbreviation |
---|---|---|---|
access | vanity | Your vanity url. | a.v |
access | publishableKey | Your publishable key. | a.k |
access | env | The environment mode the checkout instance should operate in. | a.e |
checkout type | checkoutType | The type of checkout to render. The checkout type largely determines the overall type of flow the checkout will perform. | v.t |
views | viewClose | Set the visibility of the close button inside the checkout instance. | s.p.b |
views | viewLogo | Sets the visibility of the header logo. | v.l |
views | viewExtIds | Set the visibility of various resource external ids. | v.e |
views | viewReceipt | Set what should happen once a flow completes. | v.r |
views | viewFunds | Sets the payment methods available in the checkout instance as well as the order in which they will appear. | v.f |
views | viewClose | Set the visibility of the close button inside the checkout instance. | v.c |
views | viewCheckout | Set whether the checkout displays the the billing portal chrome layout or the more compact mobile layout. | v.h |
views | viewLabels | Set the visibility of field labels globally. | v.a |
views | viewHeader | Set the visibility of the checkout instance header section. | v.hr |
views | viewSecure | Set the visibility of the security notice. This is usually the 'lock' symbol in the bottom right hand corner of the checkout instance. | v.s |
misc | customReceipt | Set a custom message on the receipt page. | s.o.r |
misc | logoUrl | Load an external image url to display as the header logo. | s.t.l.u |
misc | externalCss | Load an external css file to alter the look and feel of the checkout instance. | s.t.e |
misc | fixedAmount | Set the payment amount to be editable or fixed. | v.x |
payer | payerName | The payer name. | y.n |
payer | payerEmail | The payer email. | y.e |
payer | payerExtId | The payer external id. | y.x |
payer | payerAddressStreet | The payer street address. | y.a.s |
payer | payerAddressCity | The payer city address. | y.a.c |
payer | payerAddressPostal | The payer postal address. | y.a.p |
payer | payerAddressState | The payer state address. | y.a.d |
payer | payerAddressCountry | The payer country address. | y.a.u |
payer | payerMeta | The payer meta data. | y.a.m |
card | cardName | The name on the card. | r.c.o |
card | cardNumber | The card number. | r.c.n |
card | cardMonth | The card expiry month. | r.c.m |
card | cardYear | The card expiry year. | r.c.y |
card | cardCode | The card security code. | r.c.c |
card | cardExtId | The card external id. | r.c.x |
card | cardAddressStreet | The card street address. | r.c.a.s |
card | cardAddressCity | The card city address. | r.c.a.c |
card | cardAddressPostal | The card postal address. | r.c.a.p |
card | cardAddressState | The card state address. | r.c.a.d |
card | cardAddressCountry | The card country address. | r.c.a.u |
card | cardMeta | The card meta data. | r.c.a.m |
bank | bankNameOnAccount | The name on the bank account. | r.b.n |
bank | bankAccountType | The bank account type. | r.b.t |
bank | bankAccountHolderType | The bank account holder type. | r.b.h |
bank | bankRouting | The bank routing number. | r.b.r |
bank | bankAccount | The bank account number. | r.b.c |
bank | bankAccountRepeat | The bank account repeat number. | r.b.cr |
bank | bankExtId | The bank external id. | r.b.x |
bank | bankAddressStreet | The bank street address. | r.b.a.s |
bank | bankAddressCity | The bank city address. | r.b.a.c |
bank | bankAddressPostal | The bank postal address. | r.b.a.p |
bank | bankAddressState | The bank state address. | r.b.a.d |
bank | bankAddressCountry | The bank country address. | r.b.a.u |
bank | bankMeta | The bank meta data. | r.b.a.m |
payment | paymentAmount | The payment amount. | r.p.a |
payment | paymentCurrency | The payment currency. Supported currencies [ "USD", "CAD", "EUR", "MXN", "AUD", "GBP" ] | r.p.u |
payment | paymentDescription | The payment description. | r.p.d |
payment | paymentExtId | The payment external id. | r.p.x |
payment | paymentMeta | The payment meta. | r.p.m |
scheduled payment | spName | The scheduled payment name. | r.sp.n |
scheduled payment | spDescription | The scheduled payment description. | r.sp.d |
scheduled payment | spExtId | The scheduled payment external id. | r.sp.x |
scheduled payment | spAmount | The scheduled payment amount. | r.sp.a |
scheduled payment | spCurrency | The scheduled payment currency. Supported currencies [ "USD", "CAD", "EUR", "MXN", "AUD", "GBP" ] | r.sp.u |
scheduled payment | spInterval | The scheduled payment interval. | r.sp.i |
scheduled payment | spIntervalCount | The scheduled payment interval count. | r.sp.c |
scheduled payment | spAnchor | The scheduled payment anchor. | r.sp.r |
scheduled payment | spTimesToRun | The scheduled payment times to run. | r.sp.t |
scheduled payment | spAtDay | The scheduled payment day to run. | .sp.ad |
scheduled payment | spMeta | The scheduled payment meta data. | r.sp.m |