Chapter 2 - Overview of the AppLink Web API Process

 

The AppLink Web API (the API) provides a set of operations to submit for onboarding Merchant Application information and the supporting documents for that application. The steps below provide the API’s basic submission process along with the API operations used in the process. This overview should give you an understanding of how the API processes Merchant Application information and the API operations used in the process.

Not all of the available API operations are shown in this basic submission process and the operations are NOT described in depth. Details on each API operation are provided later in this document. The API operations not described maybe required when errors or other conditions in the submission process occur.

 

Step 1: Provide the Merchant Application information in JSON format to receive a unique ApplicationId

In this step the API is used to deliver the information from the Merchant Application to our systems. The Merchant Application information in digital form is defined by the JSON “payload” you will be provided. The JSON “payload” defines and contains the information you need to supply from the Merchant Application.

The API operation used in this step is a POST operation named /Application/US and it send the JSON “payload” file. The result of this API POST operation is a unique ApplicationId is returned. This ApplicationId will be used to link the documents you provide in Step 2 to the Merchant Application and will be also be used in Step 3 to submit the Merchant Application for processing.  

 

Step 2: Utilize the ApplicationId to provide digital copies of the documentation required for the Merchant Application

In this step the API is used to upload digital copies of the supporting documentation for the Merchant Application. The supporting documents can all be in a single file or each document can be in a separate file. You need to identify the kind of document being uploaded by providing a Document Type. The user selects one of these types that best describes the kind of document being uploaded:

  • ApplicationAndAgreement
  • ProcessingStatements
  • ProofOfBusiness
  • VoidCheck
  • EquipmentForm
  • Other
  • NonProfitEvidence

 

Digital file types accepted are outlined below. Any other file extension will cause the API to respond with a 401 Fail response.

  • XML
  • PDF
  • JPG
  • PNG
  • TIFF
  • TXT
  • DOC
  • DOCX
  • ZIP
  • JPEG
  • WAV

 

The API operation used in this step is a POST operation named /Application/US/{id}/Document where {id} is the ApplicationId returned from Step 1 above. This operation can only upload a single document at a time but can be repeated as many times as need to upload all of the supporting documents required for the application. Each execution of this step results in a document being uploaded. The result of this Post operation is either a document was successfully upload or the upload failed.

 

Step 3: Submit the Merchant Application for processing

After all the supporting documents for the Merchant Application have been uploaded in Step 2 then you are ready to submit the information. In this step the API first validates that the information provided is complete and correct. Once the API validates the information then the API submits the Merchant Application to our onboarding system.

The API operation used in this step is a POST operation named /Application/US/{id}/Submit where {id} is the ApplicationId returned from Step 1 above. The result of this API operation is either a successful submission or information is returned on what must be corrected.

Need Help?

How can we help you today?  Our team is standing by and just a click away.