Payment Links

payment links allow you to generate a hosted payment form or invoice without additional overhead a payment link is a unique url that directs a customer to a payment page to complete a transaction payment links provide a secure and straightforward method for collecting payments via channels such as email, messaging apps or social media, without requiring customers to navigate the business's website or app monoovas payment links service api provides endpoints for creating payment links, managing transactions, and handling payto (australian real time payment) agreements the payment links service supports both card payments (apple pay, google pay, visa, mastercard, american express) and account to account (payto and payid) payments sample payment links user journey a user is required to pay or is issued an invoice via the client's system (entry point) payment link url is sent to the user (e g via sms, email or other method) the user clicks the payment link and is taken to a payment page the user selects their payment method payment is made, and the ui redirects to the ‘success’ url the relevant payment notification is sent to you via webhook payment is settled to your maccount merchant api integration guide register your account call the register account endpoint endpoint post /api/payment links/register account authorization bearer \<monoova account bearer token> success registration with monoovais is complete this is mandatory before creating payment links create payment links start creating payment links at least one payment method must be enabled (either a card or payto) endpoint post /api/payment links authorization bearer \<monoova account bearer token> returns payment link url for customers bearer token is automatically stored securely optional update account there might be some updates on the pls that require the merchant to hit this endpoint only use this if advised by monoova call the update account endpoint endpoint post /api/payment links/update account authorization bearer \<monoova account bearer token> success updating the account returns the subscription id for detailed information on the payment link api , refer to the api documentation https //developer monoova com/api payment links integration flow merchant configuration settings the following settings are configurable by the merchant as part of the card payment setup these items have been extracted from the current woocommerce plugin implementation and are presented here for your review and approval before we proceed with the integration in the payment link service general controls the basic display of the card payment option on the checkout page — including the payment method title and description shown to customers variable default description affects card title credit / debit card payment method name displayed to customers checkout ui card description accept payments via mastercard, visa, apple pay and google pay short description shown below the title checkout ui payment behaviour controls how payments are captured, whether card saving is enabled, and surcharge settings variable default description affects capture yes if yes, payment is captured immediately if no, only authorisation is placed payment processing saved cards yes allows customers to save card details for future checkouts checkout ui, tokenisation apply surcharge no if yes, a surcharge fee is added to the order total order total, payment processing surcharge amount 0 00 surcharge value (percentage or fixed) applied only when apply surcharge is yes order total payment method controls which digital wallet payment options are available to customers at checkout variable default description affects enable apple pay yes shows apple pay button for eligible customers (safari / apple devices) checkout ui enable google pay yes shows google pay button for eligible customers (chrome / android devices) checkout ui enable express checkout no enables one click express checkout using saved cards or digital wallets checkout ui, checkout flow the checkout button controls the label on the payment submit button inside the card form variable default description affects order button text pay with card label displayed on the payment submit button checkout ui the express checkout button appearance o nly applies when enable express checkout is yes controls the visual appearance of the express checkout button variable default description affects express button color primary colour theme of the express checkout button values primary, dark, light checkout ui express button height 48 height of the express checkout button in pixels checkout ui express button border radius 4 corner roundness of the express checkout button in pixels checkout ui card form styling controls the visual styling of the primer rendered card form embedded at checkout note focus state (blue outline), error state (red text), and disabled button state (grey) are fixed and not configurable input labels (e g "card number", "expiry date", "cvv") variable default description input label font family helvetica, arial, sans serif font family for input field labels input label font size 14px font size for input field labels input label font weight normal font weight for input field labels input label color #000000 text colour for input field labels input fields variable default description input font family helvetica, arial, sans serif font family for text inside input fields input font size 14px font size for text inside input fields input font weight normal font weight for text inside input fields input text color #000000 text colour inside input fields input background color #fafafa background colour of input fields input border color #e8e8e8 border colour of input fields input border radius 8px corner roundness of input fields submit button variable default description submit button font family helvetica, arial, sans serif font family for the submit button label submit button font size 17px font size for the submit button label submit button font weight bold font weight for the submit button label submit button text color #000000 text colour of the submit button submit button background #2ab5c4 background colour of the submit button submit button border color #2ab5c4 border colour of the submit button submit button border radius 10px corner roundness of the submit button payment link api — card request fields the following fields are part of the createpaymentlinkrequest api and are already implemented in the payment link service these are the optional fields available to merchants when creating a payment link via the api, covering payment link behaviour, payer pre fill, branding, and card specific settings top level fields these fields control the general behaviour of the payment link — including currency, expiry, bank statement narrative, payer details, and branding all fields are optional variable type default description affects currency string aud iso 4217 currency code supported aud, usd, eur, gbp, nzd payment amount display narrative string null text shown on the payer's bank statement bank statement expiry datetimeoffset 24 hours when the payment link expires must be in the future link availability payer object null payer's personal and billing information pre fills the payment form checkout form branding object null inline white label branding for the payment page payment page ui payer these fields allow merchants to pre fill the customer's personal and billing details on the checkout form, providing a smoother checkout experience variable type default description affects firstname string null payer's first name checkout form lastname string null payer's last name checkout form emailaddress string null payer's email address checkout form, receipts billingaddress suburb string null suburb / city billing address billingaddress state string null state / province billing address billingaddress postalcode string null postal / zip code billing address billingaddress countrycode string null iso 3166 1 alpha 2 country code billing address branding these fields allow merchants to apply their own branding to the payment page — including their business name and logo this is useful for merchants who want a white label checkout experience variable type default description affects merchantname string null merchant display name shown on the payment page payment page ui logo string null url to the merchant logo image payment page ui known issue — logo url and csp restriction the payment page currently enforces a csp that restricts images to specific allowed origins if a merchant provides a logo url hosted on an external or third party domain, the image will be blocked by the browser and will not be rendered on the payment page this is an open issue that needs to be resolved before the branding feature can be used reliably by merchants possible solutions include updating the csp to allow external image sources, proxying the logo through our own domain, or requiring logos to be hosted on a whitelisted cdn card settings (cardpaymentdetails) these fields control card specific payment behaviour — including capture mode, surcharging, card saving, and accepted card types variable type default description affects saveonsuccess bool false save the card token after a successful payment for future use tokenisation allowcredit bool false allow credit cards if false, only debit cards are accepted accepted card types applysurcharge bool false apply a card surcharge to the payment amount payment amount capturepayment bool