Skip to main content

Vendor Apps

What is a Vendor App?​

A Vendor App is an internal application that interacts with the AssetEscrowLimited Platform on behalf of a registered user account. Developers create Vendor Apps to integrate AssetEscrowLimited's functionalities into their websites, mobile applications, or other digital services. These apps can interact with the AssetEscrowLimited API to create transactions, trigger payments and access limited user data.

Before you begin​

Accessing Vendor Apps​

To access your Vendor Apps:-

Creating a Vendor App​

Before creating a Vendor App, you need to think about how you would like to receive notifications from our servers.

Notifications (also called Instant Payment Notifications - IPN in short) will help you know when a transaction status changes, so you can update your database accordingly. Vendor Apps will send an IPN to the URL you provide when filling the Vendor App form when a payment is received and the transaction status changes positively.

To create a Vendor App, you will need to perform the following steps:

  • Click on Vendor Apps menu item on the left sidebar
  • Click on the Green Create vendor app button
  • Fill the Create vendor app form completely
  • Save the form.

Form fields explained​

  • App Name: The name of your Vendor App. Will appear publicly
  • Developer Email: Should be a real email. While your app is in Sandbox Mode[], We shall send OTPs and other test messaging here
  • Developer Telephone: Should be a real telephone number. While your app is in Sandbox Mode[], We shall send OTPs and other test messaging here
  • Vendor Category: Industry / sector
  • Vendor Website: Enter the complete URL of the website you are integrating Overlay Paywall here
  • Notification URL: AssetEscrowLimited will send IPN messages here in a POST request. You can leave this blank if you do not wish to receive IPN messages

Managing your vendor app​

  • Managing your Vendor App is very similar to creating a new one.
  • Please refer to the previous section for an explanation of the fields

Creating test accounts​

Once you have created your Vendor App, you next step will be to test it out. But there is a catch! While your Vendor App is in Sandbox Mode, you cannot log into the Overlay Paywall with a real AssetEscrowLimited account. This is what test user accounts are designed to do.

A test account is just a dummy account that you will use to test your Vendor App in Sandbox Mode.

To create a test account:

  • Visit your Vendor App details page and click on Test Accounts
  • Fill the form that appears
  • Click Save Changes

Playing with the hosted demo​

Each sandboxed Vendor App has access to the hosted demo website for testing purposes. To access the demo, click on View Demo Shop in your Vendor App details page

Last updated on 19 May 2024

Copyright © AssetEscrowLimited Internet Services