Creating merchant payment accounts for the users of your SaaS or platform is as simple as using our hosted payment pages. In our documents we call this process ‘Provisioning’ or ‘Onboarding’. Our provisioning API allows you to send new merchant application information for your users to Zift for immediate account setup.
As part of the provisioning process we will return the new ‘accountId’ via a callback API. You will use the accountID in other API calls such as sale transaction. Below is an overview of how to use our provisioning API. You can also visit our full provisioning API reference.
Where To Send Your Provisioning API Requests – API Endpoints
When starting your integration we recommend that you use our sandbox environment. Once you are satisfied with your integration you can connect to our production system. Below are the API endpoints for our sandbox and production.
The provisioning process allows you to suppress specific pages in the merchant creation flow. You may want to suppress a page if you have already collected specific information from the merchant when they signed up to use your service or platform. You can pass us that information behind the scenes through the API. All pages except for the agreement (terms and conditions) page may be suppressed.
If a page is suppressed the form validation will not be used. However, the API will validate all required data for type and format correctness. Below are several example of how to use the pageFormat parameter to suppress specific pages in the provisioning process.
API Data Validation
If you suppress a specific page and the passed in data is invalid your perspecitve merchant will receive an API error. Your system will not be notified. Take care to make sure that all of your data is type and format correct when suppressing provisioning pages.
= First page the prospective merchant will see.
Full Page Flow Sequence (pageFormat=OBDA)
Suppress Owner Information (pageFormat=BDA)
Suppress Owner and Business Information (pageFormat=DA)
Suppress Owner, Business and Deposit Information (pageFormat=A)
Suppress Business Information (pageFormat=BA)
In addition to the ability to pre-populate field data in the Onboarding Application you can also change how individual fields behave. You have the following field control options:
Read Only – To make a field read only add ‘@@’ to the beginning of the field value
Hidden – To make a field hidden add ‘@!’ to the beginning of the field value
Back Button Behavior
When a prospective merchant has entered invalid data they can use the back button to correct the data and then proceed. Back buttons will not give the prospective merchant access to suppressed pages to correct invalid data.