Quick Start Guide for AppLink Canada Web API


The AppLink Web API has a Developer Portal that provides a pre-production testing environment - a Sandbox. The Sandbox enables testing and experimentation with the AppLink Web API. The Sandbox provides a way to test how the payload and documents are submitted using the AppLink Web API, and to get familiar with the type of responses the API may return.

IMPORTANT: The Sandbox is not intended to be an example of how you would use the AppLink Web API in your own production environment. Using the API in production will require you to determine: how to retrieve the required information from your internal systems and processes; how to provide that payload in the proper format along with the supporting documents to the AppLink Web API. Your developed application and processes will also need to handle the API responses in order to complete the Merchant Application. How you use the API and provide the required information is up to you to design.

This quick start uses the AppLink Web API basic process described in Overview of the AppLink Web API process to demonstrate how the API operations work.

This example uses:

  • the Shared Test API key test:Testing123$ 
  • the sample payload in Appendix 5 – Payload Example 
  • a sample document: Sample Document for Uploading.pdf
AppLink Generic Shared Test Credentials
You can request a set of unique test credentials (such as an API key) from a Nuvei Integration Analyst, or you can begin testing immediately using the shared test credentials test:Testing123$ as your API key.

Step Listing link


Open the AppLink pre-production testing environment on the Innovation Center Sandbox Tools page:


You can also access the sandbox from the Main Menu of the Innovation Center. Select Sandbox Tools, then AppLink API:




Click on the CAApplication_CreateApplication hyperlink in the presented screen as shown below:



Click Set... on the HTTP Basic button.


On the SET AUTHENTICATION screen, enter test in Email, and Testing123$ in Password, then click Save.




The POST operation /Application/CA is used to send a JSON formatted payload with all of the Merchant Application data.

Paste the Payload provided in Appendix 5 - Payload Example into the Request Body section of /Application/CA, then click Send This Request.




Clicking Send This Request sends the payload data to the API. The top of the page may display Working... for several seconds during this process.

If you entered an invalid api_key, you will get the message INVALID CREDENTIALS with a response code 401.

Otherwise, the API returns the unique identifier ApplicationId for the Merchant Application payload that was submitted. The Sandbox will show the CURL used to execute the API along with the response information, including the Response Body. Note: CURL is a command line tool that can be used in UNIX for getting or sending files using URL syntax.

As shown in this example, the Response Body provides the ApplicationId, which you should note down as it will be needed for future steps.



This step enables you to upload the required merchant documentation, such as the merchant application form or a void check. The ApplicationId generated above is used to associate the documents to the payload. 


Step 6.1:  Return to the AppLink Sandbox Tools page. Click the POST CAApplication_CreateDocument hyperlink. 


Step 6.2: The Resource URL section will appear. Paste the ApplicationId generated from CAApplication_CreateApplication in the {id} area as illustrated.




Step 6.3: In the Query Parameters section, define the document type that best describes what is being attached, based upon the list below:

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

For this example, enter Other into the Values field as illustrated.





Step 6.4: Click Choose File as indicated, to locate and add the digital document file from your local file system. File types accepted are as follows:

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


Any other file extension will cause the API to respond with a 401 Fail response.

For this example, click Choose File as indicated, and select the Sample Document for Uploading.pdf that you downloaded earlier. 

Only one document file can be uploaded at a time, but you can repeat this operation as many times as needed to upload all the required supporting documents.

When you have finished, click SEND THIS REQUEST.



Step 6.5: If the upload is successful, you will receive a response code of 204. 



This step validates the payload information, then submits the merchant application to the onboarding system. If you utilized the Shared Test payload and the file provided, this operation should be a success.


Step 7.1:  Utilize the POST CAApplication_SubmitApplicationSync (Canadian Application)

Return to the AppLink Sandbox Tools page. Click the CAApplication_SubmitApplicationSync hyperlink.



Step 7.2: In the Resource URL section, paste the ApplicationId generated from CAApplication_CreateApplication in the {id} area as illustrated:


Step 7.3: Click Send This Request.

After you click Send This Request, a response code of 200 will indicate the Merchant Application was successfully submitted.

This Sandbox example shows you how the AppLink Web API is used to submit Merchant Application “payload” data and supporting documentation.

This is an example of what your application will be required to do to work with AppLink API.


You can utilize the Sandbox with your api_key and “payload” that you received by following the instructions in the section “Get your testing credentials (api_key)” as a quick test. Follow the same steps as above just substitute your unique api_key, payload and document into the steps.

Need Help?

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