Purpose of the Applink Web API

The AppLink Web API is used to submit Merchant Applications and supporting documentation which, when approved, will enable the merchant to process credit and debit transactions on our platform.

You would use the AppLink Web API to electronically provide information from your existing merchant application software along with supporting documents (such as the Merchant Application Document and voided checks) to our onboarding system.

Technology and Knowledge Required

The AppLink Web API uses Representational State Transfer (RESTful) API architectural style. The REST Architecture is not dependent on any protocol; AppLink Web API uses HTTP as the underlying protocol, including the built-in status codes to indicate API errors. The API documentation is written with the assumption that you have experience and knowledge of the REST architecture.

The AppLink Web API has a Developer Portal that provides a pre-production testing environment – a Sandbox.

The AppLink Web API operations expect the information to be in JSON (JavaScript Object Notation) format. JSON is an open-standard file format using human-readable text for transmitting data. This documentation is written with the assumption that you have experience and knowledge of JSON file formats.

Applink Web Payload

The AppLink Web API uses a JSON file to digitally provide the information contained on a Merchant Application. This document refers to this JSON file as a payload. Your Integration Specialist or Relationship Manager will provide the payload JSON layout and data items to you. The payload is unique to the type of Merchant Applications you can process.