Test and Go Live
Meet testing requirements and convert to a Maast production account.
Once you've followed our guides to implement payments with a Maast sandbox account, this page takes you through the next steps to convert to a production account and start taking payments.
Who's this guide for?
If you are a merchant working through an ISV, you don't need to follow this guide. Simply fill out the online application you receive from your ISV, and you will be set up for production.
If you are an ISV or a merchant working independently, this guide is for you. Find your integration method below and follow the steps in that section:
Hosted Checkout
If you are using Hosted Checkout for payments, use this section to apply for a production account and go live.
Test: Permanent Link
If you are using the Hosted Checkout permanent link method, perform these tasks to test your integration:
1. Open a sandbox account - Follow the steps in Create a Sandbox Account to sign up and log in to the merchant sandbox portal.
2. Create a checkout form - Use the Permanent Link Method guide to create and configure a new checkout profile. Copy the permanent link URL.
3. Configure the email receipt - In the merchant sandbox portal, select 'Administration' in the left-hand menu. Under 'Account Configuration,' select 'Settings,' and then select the 'Receipts' tab. Use this page to configure the default receipt information.
4. Access the checkout form - Use your permanent link URL to access the hosted page. Check that the page appears as you configured it.
5. Fill the form - Using test payment card or ACH numbers, fill the required fields and submit a test payment. Include an email address to test the receipt.
6. Check functionality - If you entered a custom success URL in configurations, check that you are redirected to it. If you did not enter a custom URL, check that you are redirected to the hosted receipt. Select 'Email' and check that the receipt is sent and that it appears as you configured it.
7. Verify transaction - In the merchant sandbox portal, select 'Transactions' in the left-hand menu. Check that the test transaction's data appears in this table.
Once you've tested your integration, see below to go live as a Maast merchant or partner.
Test: Dynamic Link
If you are using the dynamic link method, perform these tasks to test your integration:
1. Open a sandbox account - Follow the steps in Create a Sandbox Account to sign up and log in to the merchant sandbox portal.
2. Create a checkout form - Use the Dynamic Link Method guide to create a new checkout profile and copy the permanent link URL.
3. Configure the email receipt - In the merchant sandbox portal, select 'Administration' in the left-hand menu. Under 'Account Configuration,' select 'Settings,' and then select the 'Receipts' tab. Use this page to configure the default receipt information.
4. Create a checkout link - Use your integration to send a Create a Checkout Link request. If you configured the hosted form in portal, include its checkout profile ID in the checkout_profile_id
field in the request. Check that this returns a success response that includes a URL in checkout_link
.
5. Access the payments form - Use the checkout_link
URL from the test response to access the hosted checkout page or modal. Check that the page or modal appears as you configured it.
6. Fill the form - Using test payment card or ACH numbers, fill the required fields and submit a test payment. Include an email address to test the receipt.
7. Check functionality - If you entered a custom success URL in configurations, check that you are redirected to it. If you did not enter a custom URL, check that you are redirected to the hosted receipt. Check that the receipt is emailed and that it appears as you configured it.
8. Verify transaction - In the merchant sandbox portal, select 'Transactions' in the left-hand menu. Check that the test transaction's data appears in this table.
Once you've tested your integration, see below to go live as a Maast merchant or partner.
Go Live: Merchant Account
If you are applying for a Maast merchant production account, follow these steps to go live with your Hosted Checkout integration:
1. Apply for production credentials - Contact Maast Support to apply for a production account.
2. Update credentials - Once Maast has approved your application and sent your production portal login information, do the following:
- Log in to the Maast merchant production portal at https://app.maast.com/login/maast.
- Permanent link - If you are using the permanent link method:
- Follow the Permanent Link Method guide, but use your merchant production portal instead of the sandbox portal. Configure notifications and receipts. Save the generated URL.
- Go through your integration and update all instances of your permanent link to use the URL you generated in the production portal.
- Dynamic link - If you are using the dynamic link method:
- Follow Get Your API Credentials for merchants, but use your production portal instead of the sandbox portal.
- Follow the steps in Authentication to format your production credentials and generate your production API token.
- Go through your integration and change all of your credentials to use your production API token. Configure notifications and receipts.
- Go through your integration and change all endpoints from the test base path (
https://api-test.maast.com
) to the production base path:https://api.maast.com
.
Change all API endpoints and credentials
To start using your production account with the dynamic link method, you must change all request credentials to use your production API token and all endpoints to the production base path:
https://api.maast.com
.If you are using additional API requests--including webhooks--you must do this for each request.
You can now start transacting!
Go Live: Partner Account
If you are an ISV applying for a Maast partner production account, follow these steps to go live with your Hosted Checkout integration:
1. Apply for production credentials - Contact Maast Support to apply for a production account and request the access to use Hosted Checkout.
2. Update credentials - Once Maast has approved your application, do the following:
- Log in to your Maast partner production portal at https://app.maast.com/login/partner/maast.
- Log in to your merchant production portal by following Create a Sandbox Account for merchants, but use the production URL https://app.maast.com/login/maast instead of the sandbox URL.
- Permanent link - If you are using the permanent link method:
- Follow the Permanent Link Method guide, but use your merchant production portal instead of the sandbox portal. Save the generated URL.
- Go through your integration and change all instances of your permanent link to use the URL you generated in the production portal.
- Dynamic link - If you are using the dynamic link method:
- Follow Get Your API Credentials for partners, but use your production portal instead of the sandbox portal.
- Follow the steps in Authentication to format your partner production credentials and generate your production API token.
- Go through your integration and change all of your credentials to use your production API token.
- Go through your integration and change all endpoints from the test base path (
https://api-test.maast.com
) to the production base path:https://api.maast.com
.
Change all API endpoints and credentials
To start using your production account with the dynamic link method, you must change all request credentials to use your production API token and all endpoints to the production base path:
https://api.maast.com
.If you are using additional API requests--including webhooks--you must do this for each request.
You can now start transacting!
Embedded Fields
If you are integrating with embedded fields, use this section to perform recommended tests, apply for a production account, and update your integration to go live.
Test Your Integration
Follow the steps in the Get Started guide to create a merchant sandbox account, get your sandbox testing credentials, and integrate payments using embedded fields.
To ensure your integration will succeed in production, use test card data (and/or test ACH data) to perform a sale transaction through your site or app integration. Check for a successful transaction.
Additionally, check that the card_id
is tokenizing as planned. If you want to use the embedded fields transient token, note that you must include tokenize
set to true
in your JavaScript.
Once your integration has passed all tests, see below to go live as a Maast merchant or partner.
Go Live: Merchant Account
If you are applying for a Maast merchant production account, follow these steps to go live with your embedded fields integration:
1. Apply for production credentials - Contact Maast Support to apply for a production account using embedded fields.
2. Update API credentials - Once Maast has approved your application and sent your production portal login information, do the following:
- Log in to the Maast merchant production portal at https://app.maast.com/login/maast.
- To get your production credentials, follow the steps in Get Your API Credentials for merchants, but use the production portal instead of the sandbox portal.
- Follow the steps in Authentication to format your production credentials and generate your production API token.
- In your 'Get Transient Key' request, change the credentials to use your production API token.
3. Update API endpoints - Update your 'Get Transient Key' request to use your production endpoint: https://api.maast.com/platform/embedded
.
4. Update JavaScript mode
- In your JavaScript, change mode
from test
to prod
. See the code sample in Embedded Payments.
You can now start transacting!
Change API and JavaScript
When moving to production with an embedded fields integration, don't forget to change both your API request and your JavaScript to production values.
Go Live: Partner Account
If you are an ISV applying for a Maast partner production account, follow these steps to go live with your embedded fields integration:
1. Apply for production credentials - You can apply to go live one of two ways:
- Open your Maast partner sandbox portal and select the 'Go Live' button in the top right corner, or
- Contact Maast Support to apply for a production account using embedded fields.
2. Update API credentials - Once Maast has approved your application, do the following:
- Log in to your Maast partner production portal at https://app.maast.com/login/partner/maast.
- To get your production credentials, follow the steps in Get Your API Credentials for partners, but use your production portal instead of the sandbox portal.
- Follow the steps in Authentication to format your production credentials and generate your production API token.
- In your 'Get Transient Key' request, change the credentials to use your production API token.
3. Update API endpoint - Update your 'Get Transient Key' request to use your production endpoint: https://api.maast.com/platform/embedded
.
4. Change JavaScript mode
- In your JavaScript, change mode
from test
to prod
. See the code sample in Embedded Payments.
You can now start transacting!
Change API and JavaScript
When moving to production with an embedded fields integration, don't forget to change both your API request and your JavaScript to production values.
API
If you are using API in your integration, use this section to perform recommended tests, apply for a production account, and update your integration to go live.
Test Your Integration
Follow the steps in the Get Started guide to create a merchant sandbox account, get your sandbox testing credentials, and integrate payments through API.
Sale
Perform the following tests to ensure your Payment Gateway API integration will succeed in production:
1. Sale - Send a Sale (Auth + Capture) request. In addition to the required fields, include the following in the payload of the request:
client_ip
developer_id
billing_zip
purchase_id
See Sale (Auth + Capture) in API reference for more information on these values.
Confirm that you receive a success response. Save the pg_id
value from the response.
2. Recurring Sale - If you plan to make recurring transactions through the Sale (Auth + Capture) request, do the following:
- Send a 'Sale' request as in "1. Sale," above.
- In the payload of the request, include
moto_ecomm_ind
set to2
(recurring). - Confirm that you receive a success response.
3. Refund - Send a Refund Previously Captured Transaction request. Use the pg_id
value from above in this request's pgIdOrig
field. Confirm that you receive a success response.
4. Other tests - Maast may request you perform other tests based on the payments workflow of your business.
Recurring Billing
If you plan to use Recurring Billing API endpoints, perform these tests:
1. Add a Recurring Plan - Do the following:
- Send an Add a Recurring Plan request.
- Check that you receive a success response.
- Save the
plan_code
value from the request.
2. Add a Subscription - Do the following:
- Send an Add a Subscription request including these values:
- The
plan_code
value from above. date_start
set to the following day.- A valid email address. If one is not already associated with the
customer_id
you are using, you should include one in thecustomer
object of this request.
- The
- Upon sending the request, check that you receive a success response. Save the
subscription_id
value from the response. - Wait until the following day, then check that the provided email address has received an invoice. Check that the invoice contains a link to the payment form, and that the payment form is set up as expected.
3. Cancel a Subscription - Do the following:
- Send a Cancel a Subscription request using the
subscription_id
value from above. - Check that you receive a success response.
4. Resume a Subscription - Do the following:
- Send a Resume a Subscription request using the
subscription_id
value from above. - Check that you receive a success response.
Once you've tested your integration, see below to go live as a Maast merchant or partner.
Go Live: Merchant Account
If you are applying for a Maast merchant production account, follow these steps to go live with your API integration:
1. Apply for production credentials - Contact Maast Support to apply for a production account.
2. Update API credentials - Once Maast has approved your application and sent your production portal login information, do the following:
- Log in to the Maast merchant production portal at https://app.maast.com/login/maast.
- To get your production credentials, follow the steps in Get Your API Credentials for merchants, but use the production portal instead of the sandbox portal.
- Follow the steps in Authentication to format your production credentials and generate your production API token.
- Go through your integration and change all of your credentials to use your production API token.
3. Update API endpoints - Go through your integration and change all endpoints from the test base path (https://api-test.maast.com
) to the production base path: https://api.maast.com
.
You can now start transacting!
Go Live: Partner Account
If you are an ISV applying for a Maast partner production account, follow these steps to go live with your API integration:
1. Apply for production credentials - You can apply to go live one of two ways:
- Open your Maast partner sandbox portal and select the 'Go Live' button in the top right corner, or
- Contact Maast Support to apply for a production account.
2. Update API credentials - Once Maast has approved your application, do the following:
- Log in to your Maast partner production portal at https://app.maast.com/login/partner/maast.
- To get your production credentials, follow the steps in Get Your API Credentials for partners, but use your production portal instead of the sandbox portal.
- Follow the steps in Authentication to format your production credentials and generate your production API token.
- Go through your integration and change all of your credentials to use your production API token.
3. Update API endpoints - Go through your integration and change all endpoints from the test base path (https://api-test.maast.com
) to the production base path: https://api.maast.com
.
You can now start transacting!
Updated 11 months ago