Dynamic Link Method

Set up Hosted Checkout with the dynamic link method.

Dynamic Checkout, or the dynamic link method, is a method for securely processing transactions by redirecting customers to a hosted payment page or modal window. This page gives an overview of Dynamic Checkout and instructions for setting up Hosted Checkout with dynamic links. Subpages in this guide provide information on using Customer Vault, modal windows, and additional features with Dynamic Checkout.

Features

The dynamic link method has the following benefits:

  • Easy to set up - Set configurations in Maast Manager or through API.
  • Easy to manage - Links display as a modal payment window or a full page hosted by Maast.
  • Convenient for customers - Use with Customer Vault to save information for repeat transactions.
  • Convenient for you - Support partial payments, repeat transactions, and reporting.
  • Unique to you - Customize the appearance of your Checkout page.
  • Secure - All cardholder data is collected and processed by Maast, a PCI DSS certified Level 1 compliant Service Provider.

The method supports these transaction types:

  • Sale - Authorize and capture payment in a single message.
  • Authorization - Send cardholder data to the issuing bank for approval.
  • Tokenize - Add credit card or ACH payment information to an existing customer ID in Customer Vault or create a new customer ID with tokenized payment information.
  • Tokenize and Verify - Verify payment information before tokenizing a credit card. Fees may apply.

It supports the following forms of payment:

  • Visa
  • Mastercard
  • Discover
  • American Express
  • Google Pay™
  • ACH

It supports these currencies:


It supports these payment types:

  • E-commerce
  • Mail Order
  • Telephone order

How It Works

The following diagram shows the Dynamic Checkout workflow:


Generate a Link

  1. The customer elects to pay.
  2. Your server posts checkout information to the Maast server, which generates and returns a unique link.
  3. The link redirects the customer to a hosted Checkout page.

Process Payment

  1. The checkout information automatically populates the Checkout page, and the customer submits payment details directly to Maast.
  2. Maast sends the payment information to the card brands for authorization and receives an approval or decline.
  3. Maast returns the approval or decline to Checkout.

Notify

  1. The customer is redirected to your confirmation URL or the Checkout receipt page.
  2. Optionally, Maast can post a call back to your server.
  3. Either Maast or your server can generate and email a receipt.

Integrate

Follow the instructions below to set up a Hosted Checkout page or modal window with the dynamic link method and to customize its appearance and function.

Create a Sandbox Account

See Create a Sandbox Account to set up and log in to a merchant sandbox account in the Maast Manager portal, which you can use to create and configure your Checkout page.

This sends you to your open sandbox account, where you can find the security key for test API requests.

Get Your Sandbox Security Key

Follow the steps in Get Your API Credentials to generate and save your sandbox merchant ID and API security key, which you will use in your API request.

Next, you can use the instructions below to configure your preferences in Maast Manager, or you can go straight to implementing Hosted Checkout.

Configure Your Checkout Preferences in Maast Manager

This section provides instructions to create a dynamic Checkout profile in Maast Manager and set its configurations. This is an easy way to customize the appearance and function of your Hosted Checkout payment workflow.

📘

You can also set these configurations in a Create a Checkout Link API request. If you use API configurations, they will override configurations set here.

Create a Dynamic Checkout Profile

Follow these steps to create a Checkout profile, which will communicate your configurations to the API:

  1. In your sandbox account, select 'Administration' in the left-hand menu.
  2. Under 'Account Configuration,' select 'Settings.'
1007

This takes you to merchant account settings:

1286
  1. Select the 'Checkout' tab at the top.

This opens the Checkout configurations page:

1288
  1. Select 'New Checkout Profile.'

This opens a form to create a new Checkout profile:

1290
  1. For the 'Checkout Name' prompt, type in a distinct name (preferably one you can distinguish from any other links you create).
  2. Leave 'Dynamic Profile' selected.
  3. Select 'Create Checkout Profile.'

This redirects you to the Hosted Checkout configurations page. See the instructions below to change the settings for your Checkout profile on this configurations page.

Access Settings

Follow these steps to access the configurable settings for your Checkout profile:

  1. In your Maast Manager sandbox account, select 'Administration' in the left-hand menu.
  2. Under 'Account Configuration,' select 'Settings.'
1007

This takes you to merchant account settings:

1286
  1. Select the 'Hosted Checkout' tab at the top.

This opens the Checkout configurations page:

1289
  1. Below 'New Checkout Profile,' ensure that the desired Checkout profile is selected. To change profiles, click on the name below 'New Checkout Profile' and select from the drop-down menu that appears.

You are now on the Hosted Checkout configurations page for your dynamic Checkout profile and the Checkout page it supports.

The instructions below guide you through setting your preferences in each section on the left side of the configurations page. The 'Preview' section on the right shows what a customer will see on the Checkout page.

🚧

Save Changes

Changes to Hosted Checkout configurations do not automatically save. Remember to select 'Save Changes' to set your configurations.

Edit the Checkout Profile

The 'Edit Profile' section lets you view and edit the status and identifying information of your dynamic Checkout profile:

308
  • Checkout Name - Type to edit the profile name.
  • Checkout Profile ID - View the ID number of the dynamic Checkout profile. The API requires this if your account has multiple active profiles.
  • Status - Toggle this to 'Active' to activate the profile. Toggle to 'Disabled' to disable the profile.
  • Checkout Profile Type - View the profile type. This should say 'Dynamic Profile' for the dynamic link method.

Set Preferences

The 'Preferences' section lets you edit the path of the payment workflow:

405
  • Expire Link in - Type the length of time each dynamic Checkout link should remain valid. Click 'Minutes' to select between minutes and days.
  • Success URL - Your customer is sent to this page after a successful transaction.
    • To send customers to the default Maast receipt page, leave this field blank.
    • To send customers to a custom URL, type the URL here. It must be formatted as http://www.domain.com/ or https://www.domain.com/
  • Failure URL - Your customer is sent to this page after a failed transaction.
    • To send customers to the default Maast receipt page, leave this field blank.
    • To send customers to a custom URL, type the URL here. It must be formatted as http://www.domain.com/ or https://www.domain.com/
  • Default Request Type - Use the drop-down menu to choose between 'Sale' and 'Authorization Only.'
    • You must select 'Sale' to support ACH payments.
    • If you select 'Authorization Only,' you will need to capture transactions manually via Maast Manager or the Payment Gateway API.
  • Captcha - This controls the presence of a reCAPTCHA challenge on your Checkout page.
    • Leave this set to 'Present if Suspicious,' and a challenge will appear when a payment request is suspected to originate from a bot.
    • Select 'Present Always' to show a challenge for every transaction.
    • Select 'None' to show no reCAPTCHA challenges.

Customize Page Introduction

The 'Page Introduction' section allows you to customize the appearance and wording at the top of your dynamic Checkout page:

317
  • Logo - Upload a header image to display on your Checkout page.
    • The image must be a png file of 2 MB or less.
    • Drag the file into the 'Logo' space, or click 'Choose or drag files here' to select a file.
  • Headline - Type a header to display at the top of your Checkout page.
  • Introduction - Type a subheader to display at the top of your Checkout page.

Set Payment Amount and Frequency Options

The 'Amount & Frequency' section controls a customer's options for the amount and frequency of their payment and the use of a purchase ID:

565
  • Frequency Label - Type a header to display above your optional frequency buttons.
  • Frequency Description - Type a subheader to display above your optional frequency buttons.
  • Frequency - You can select one or more buttons.
    • Each highlighted button will appear on your Checkout page for a customer to choose that frequency of payment.
    • If you select one or more frequency buttons, you must require 'Name' or 'Company/Firm Name' in the 'Personal Information' section.
  • Frequency Duration - If you have selected one or more frequency buttons above, you must select whether you will 'Bill until canceled' or 'Bill for a fixed period.' If you select 'Bill for a fixed period,' you are prompted to enter the number of billing cycles for which you wish to bill. Type or use the arrows in the text box to enter the number of billing cycles.
  • Display amount at bottom - If toggled 'off,' payment amount fields appear above 'Personal Information' on your Checkout page. If toggled 'on,' they appear below 'Personal Information.'
  • Amount Label - Type a header to display above the payment amount options on your Checkout page.
  • Amount Description - Type a subheader to display above the payment amount options on your Checkout page.
  • Amount Type - This has several options:
    • Allow customer to enter amount at checkout - If you select this, the customer may enter the payment amount and you do not provide set amounts.
    • Single Amount - This charges one preset amount.
      • Deselect 'Allow customer to enter amount at checkout' and leave 'Single Amount' deselected.
      • Type into the 'Amount' prompt that appears.
    • Multiple-Choice Amount - This shows a list of preset amounts for your customer to select.
      • To choose this, click 'Single Amount.' The toggle is highlighted and displays 'Multiple-Choice Amount.'
      • Type into the 'Amount' prompt that appears, then press Enter or select 'Add Amount.' You can add several preset amounts this way.
      • Remove an amount with its black 'X' icon.
    • Other Amount Option - Appears when you have entered at least one preset amount under the 'Multiple-Choice Amount' setting. Toggle this to 'Yes' to display an 'Other' button on your Checkout page, which a customer may select to enter their preferred amount.
  • Purchase ID Label - Type a header to display above the purchase ID field on your Checkout page. This will only display if you elect to use the purchase ID field.
  • Purchase ID - Select this to use the purchase ID field on your Checkout page.
    • You can use this to request something that will make sense to your workflow, like invoice number or account number.
    • This value will be included in Maast reports.
    • A purchase ID may be no more than 25 characters.
    • When 'Purchase ID' is on, the 'Required' prompt appears. Toggle it to require a purchase ID input.

Configure Personal Information Fields

The 'Personal Information' section lets you modify which identifying information to request or require of a customer:

534
  • Header - Type a header to display above the 'Personal Information' section on your Checkout page.
  • Description - Type a subheader to display above the 'Personal Information' section on your Checkout page.
  • The remaining options control which personal information fields you display and require on your Checkout page. If set to 'Yes,' the field will show on the Checkout page and the 'Required' option appears in configurations. Select 'Required' to require that a customer enter this information:
    • Name (First, Last)- You must require 'Name' or 'Company/Firm Name' to use any of the billing frequency options.
    • Company/Firm Name
    • Full Address - You may enable either 'Full Address' or 'Postal Code,' but not both.
    • Postal Code
    • Phone Number
    • Email - If you choose to email receipts to your customers, you must require this field.

Add Optional Fields

The 'Option Field' section lets you request or require further information from a customer:

485
  • Label - Type a header to display above the optional fields on your Checkout page.
  • Description - Type a subheader to display above the optional fields on your Checkout page.
  • Field Type - This has multiple options:
    • Radio - This displays preset options, and the customer can choose only one.
      • Select 'Radio,' and the 'Field Type Options' prompt appears.
      • Type into the 'Field Type Options' prompt, and press Enter or click on the '+' sign next to the prompt. You can add several options this way.
      • Remove an option by clicking its black 'X' icon.
      • Select 'Required' to require the customer to choose an option.
    • Checkbox - This displays preset options, and the customer can make multiple selections.
      • Select 'Checkbox,' and the 'Field Type Options' prompt appears.
      • Type into the prompt, then press Enter or click on the '+' sign next to the prompt. You can add several options this way.
      • Remove an option by clicking its black 'X' icon.
      • Select 'Required' to require the customer to choose an option.
    • Text - This allows the customer to type an input. Select 'Required' to require the customer to enter something here.
    • Reset - Select this to remove the optional fields from your Checkout page.

Configure Payment Settings

The 'Payment Settings' section lets you control payment type options and add a surcharge or convenience fee:

527
  • Header - Type a header to display above the payment information fields on your Checkout page.
  • Introduction - Type a subheader to display above the payment information fields on your Checkout page.
  • Allow Digital Wallets - Set this to 'Yes' to allow payments from digital wallets. When this is enabled, a toggle will appear to select whether to accept Google Pay.
  • Allow ACH Payment - Set this to 'Yes' to allow ACH payments. If you do not see this option and are using USD, please contact Maast support to have your account enabled for ACH payments.
  • ACH Payment Label - This appears when 'Allow ACH Payment' is set to 'Yes.'
    • Choose how you would like to label the ACH payment option button on your Checkout page: 'ACH,' 'eCheck,' or 'Bank Account.'
    • This setting only changes what your customer sees. The option functions the same regardless, and Maast Manager refers to all ACH payments as 'ACH payments.'
  • Display Security Code (CVV) - When set to 'Yes,' you can collect the security code (CVV) from your customer (recommended).
    • When you select 'Yes,' the 'Required' option appears.
    • Select 'Required' to require the payment card's CVV.
  • Show 'Save Payment Information' Option - Set this to 'Yes' to let a customer choose to save their payment information.
    • To enable this option, you must send a customer ID when invoking Maast Checkout.
    • When a customer chooses to save their information, a Customer Vault entry is created.
    • If you leave this field on 'No,' payment information is always saved after a successful checkout.
  • Add Fee Recovery - Set this to 'Yes' to add a surcharge or a convenience fee.
    • When 'Add Recovery Fee' is selected, select 'Surcharge' or 'Convenience Fee.' Type the amount you wish to add.
    • See more on adding surcharges here.
    • See more on adding convenience fees here.
    • If you do not see this option, contact Maast support at [email protected].
  • Payment Button Text - Type the text you would like to show on the submit button, such as 'Donate Now' or 'Buy Now.'

Remember to select 'Save Changes' to set your configurations. Changes to Hosted Checkout configurations do not automatically save.


Implement

Do the following to implement Dynamic Checkout:

If you have one Checkout profile - Follow the steps in Create a Checkout Link to create a dynamic link. Use the API security key generated above.

If you have more than one Checkout profile:

  1. Follow the steps in Access Settings to go to the Maast Manager configurations page for the Dynamic Checkout profile you wish to use.
  2. Find that profile's Checkout profile ID in the 'Edit Profile' section. Copy and save that value:
1288
  1. Follow the steps in Create a Checkout Link to send a request to create a link. Note:
    • For authorization, use the API security key generated above.
    • In the checkout_profile_id field, enter the Checkout profile ID.

Test and Go Live

See our Test and Go Live guide to test the integration and configurations of your dynamic link and to start transacting with an active production account.