Submitting an application

🚧

In development

A legacy version of the Merchant Boarding API is live currently, however a new enhanced version is in development. For new consumers, it is highly recommended to use the new version of the API expected in Q3 2022.

Please note the API specification may change while it's in development

Submitting an Application

When an application is ready to be submitted, use the /merchant-application/{merchantApplicationId}/submit endpoint. The application is then validated first to make sure the mandatory information is provided, before trigging the back-end systems. If it passes validation, the applicationStatusCode on the merchant application resource will change to APPLICATION_READY_FOR_BOARDING.

After the merchant application is submitted, no details of it cannot be updated anymore. Submitting such a request triggers the automated processes in the backend unless it is rejected by the validation service of the API.

Application Status Codes

EnumerationDescription
OPENSaves the provided details in Fiserv systems but no action is trigerred. Details can be retrieved at any point later. The application can still be edited.
INTERVENTION_NEEDEDThis code is an optional code the consumer can use to indicate that the merchant needs help/intervention. This could be used because the merchant has asked for help or they've left their application for a period of time. The application can still be edited.
INTERVENTION_REQUIREDThis code is an optional code the consumer can use to indicate that the merchant requires help/intervention becuase they have hit a business limitation e.g. the turnover they entered requires boarding to be assisted. The application can not be edited until intervention has been resolved.
APPLICATION_READY_FOR_BOARDINGFiserv's systems trigger the processes needed to activate the merchant along with the services and equipment. The application can no longer be edited.
APPLICATION_IN_PROGRESSUsed in scenarios when Fiserv's underwriting solution is used to assess the credit risk of the merchants. The application can no longer be edited. This status is automatically updated by Fiserv.
APPLICATION_DECLINEDWhen the credit risk assessment does not pass and the merchant's application is declined by the Fiserv's underwriting systems. The application can no longer be edited. This status is automatically updated by Fiserv.
READY_TO_ACTIVATEMerchant boarding performed successfully. The activation of the services and equipment is to follow automatically. The application can no longer be edited. This status is automatically updated by Fiserv.
ACTIVATION_IN_PROGRESSActivation of the services and equipment is in progress. The application can no longer be edited. This status is automatically updated by Fiserv.
COMPLETEDMerchant is now active. This status is automatically updated by Fiserv.
CANCELLEDTo be used when the onboarding process needs to be stopped

Did this page help you?