Data Storage Options

There are two options for storing payment information:

Customer Vault

Customer Vault is a Maast feature that securely stores tokenized payment information to a customer profile. You can access Customer Vault through the Maast Manager portal and our API. You can retrieve and use the stored customer information any time using a customer ID or tokenized card ID. See Using Customer Vault below for a breakdown of the ways you can access and use this feature.

Payee Vault

Merchants set up with and paid from an FBO account can also store payee information and payment information in a payee profile with a unique payee ID. This is intended for a specific use case, and it requires integration through the Maast product team. To use this feature, please contact Maast Support. Once you are set up, you can interact with information in Payee Vault through two methods:

Sending requests to our Payee Vault API endpoints.
Using the 'Payee Vault' feature in the Maast merchant portal.

Tokenization

Maast's Payment Gateway API supports tokenizing and storing payment information without an associated customer profile. You can use this feature to maintain a customer database in your own system that stores payment tokens you obtain from Maast. See Card or Bank Account Data Sources and Conditional Requirements for the types of data required and allowed.

To access this feature, send a Tokenize request via our Payment Gateway API.
Alternatively, you can send the tokenize field set to true in one of the following requests:

The API will return a tokenized card_id value for the payment information you sent. Save and use the card_id value in lieu of payment information.

Embedded fields also supports this feature, using the Payment Gateway API to tokenize payment information and return a reusable card_id. To do this, include the tokenize field set to true. See the Embedded Payments guide for more information.

🚧
When using Payment Gateway API or embedded fields to tokenize payment information, Maast does not maintain a customer database for you. You must save card_id values in your own system to access them later.

Using Customer Vault

You can access Customer Vault to store and retrieve information in multiple ways. See below for a breakdown of the methods available through the Maast Manager portal and via the API.

Maast Manager Portal

Add/edit information as a merchant

As a merchant, you can add information to Customer Vault directly through the Maast merchant portal. To do so, follow the steps in Create a Sandbox Account to create and log in to a Maast merchant sandbox account. Select ‘Customers’ in the left-hand menu. Select ‘New Customer’ and fill in the form that appears. To save a new profile, one of the following is required at minimum:

First Name, Last Name, and Customer ID (or choose to auto-generate a customer ID)
Business Name and Customer ID (or choose to auto-generate a customer ID)

Select ‘Create.’ Using the portal, you can add further information at any time, and you can always edit any value except the customer ID.

Permanent link for customers to add/edit information

In Maast merchant portal, you can generate a permanent link to a hosted checkout page that lets a customer choose to save their information to Customer Vault as they pay. To do this, follow the steps in Permant Link Method to generate and configure a checkout page. In the page’s configurations, select to show the 'Save Payment Information' option.

Dynamic link for customers to add/edit information

Using Maast merchant portal and a Checkout API request, you can generate a dynamic link to a hosted page or modal that lets a customer save their information to Customer Vault. Two types of checkout profile support this:

Dynamic checkout profile - Use a dynamic profile for your hosted page/modal to let the customer save their information as they pay.
Vault checkout profile - Use a vault-type profile for this page/modal to let the customer save their information without an option to pay.

To use a dynamic checkout profile, follow the steps in Dynamic Link Method to create, configure, and implement a hosted page or modal. In configurations, select to show the 'Save Payment Information' option.

To use a vault checkout profile, follow the dynamic link method’s Customer Vault guide to create, configure, and implement a hosted page or modal for Customer Vault entries.

API

You can interact with Customer Vault in various ways through multiple Maast API endpoints. See below for methods using the Customer Vault API resource and the Checkout API resource.

Customer Vault API request

The Customer Vault API resource is the main collection of endpoints that support interaction with Customer Vault. For example, you can send an Add a Customer request to save a new profile to Customer Vault and Get All Customers to see data saved in your Customer Vault.

Adding payment method information returns a card_id value associated with that payment method. You can use that card ID in Payment Gateway API requests.

See our Customer Vault API guide for more information.

Checkout API request

The Create a Checkout Link request can generate a dynamic link to a hosted page or modal where a customer can add or edit information in Customer Vault. There are three ways to do this:

Vault checkout profile ID from Maast Manager - Follow the dynamic link method’s Customer Vault guide to create, configure, and implement a hosted page or modal for Customer Vault entries. This lets the customer save their information without an option to pay.
Dynamic checkout profile ID from Maast Manager - Follow the Dynamic Link Method guide to create, configure, and implement a hosted payment page or modal. In configurations, select to show the 'Save Payment Information' option.
This lets the customer save their information as they pay.
No checkout profile ID - If you have not used the Maast Manager portal to create multiple checkout profiles, you can send ‘Create a Checkout Link’ without the checkout_profile_id field. (This uses the default checkout profile in your merchant portal.) In the preferences object, include allow_save_card set to true.
This generates a dynamic link to a hosted payment form where the customer can add or edit Customer Vault information as they pay.