Docs

Platform Setup

Welcome to the Platform Setup section.

In the Platform Setup manual, you'll find detailed explanations on how to manage menu Catalog in Vendo Backoffice.


Shared Secret

Your Shared Secret can be found under "Catalog -> Merchants -> Settings" of Vendo Backoffice.

The Shared Secret is a password that you must use when using Vendo’s APIs. It's available to you once we receive your signed contract.
If you use NATS then you’ll use it to configure the biller settings.
If you use Gateway API or eCommerce platform solution then you would receive your Gateway API Secret after the successful testing phase.

Importance of postback

Postbacks, also known as callbacks or webhooks, are essential for confirming successful transactions, enabling accurate record-keeping and prompt customer notifications.

Vendo's platform uses postbacks to send information directly to your system. To utilize this feature, simply configure your postback endpoint in Vendo's back office for each of your sites. Go to Catalog > Sites> URLs > Postback URL > Change postback endpoint URL

If you encounter a postback issue with any of your end-users, you can resend the postback (Adduser callback or Transaction callback) to ensure the action is correctly captured. See instructions below.

Important note: Please be aware that once a transaction is completed and the user is charged, failure to process the postback or provide a valid response from your platform can lead to access problems, which could negatively affect the user experience.

To address this, follow these steps:

  • Log in to the Vendo Backoffice.
  • Locate the subscription (for Adduser callback) or the transaction (for Transaction callback) with the issue.
  • In the top right corner of the panel, you'll see a 'Resend' button.
  • Click the arrow next to the button.
  • Resend the desired postback.

IP Whitelisting Guidance for Host Server Changes

If a merchant changes host servers but the postback URL remains unchanged, there is no need to whitelist new IP addresses. However, please note that Vendo only sends postbacks from a specific list of IP addresses. More information on this topic, including the updated list of IP addresses, can be found here.

Deactivating an offer

If you are no longer using an offer, you can deactivate it in the Back Office. This is particularly important if the repurchase option is enabled for your account, as it will prevent customers from purchasing a new subscription at the old pricing.

  • Navigate to Catalog > Offers and select the offer.
  • On the right-hand there is a button "Deactivate".

  • click the "Deactivate" button.
    • the message will show "The offer has been successfully deactivated"
    • To undo this action, click the "Activate" button.

Setting Local Currency for Offers

When adding a currency to a new offer, there is a wide variety of currencies to choose from, though the baseline will always be set in USD. On the product page, the currency displayed will be the one used in the country where the customer is located, providing a more user-friendly experience. However, it’s important to remember that currency exchange rates will be applied during the payout process. To add a preferred currency, navigate to Catalog > Offers, scroll down to the Billing Schedule, and click the arrow in the "Price" section next to the price in USD. Adjust the necessary details, then click "Save changes."


Unique Identifiers and Multi-Site Use of Offers

An offer is a pricing plan that combines the price and duration customers pay for a product. Each offer has a unique identifier and can be used across multiple sites for added flexibility.


Username and Password Requirements for New Users

By default, usernames and passwords must consist of 6-12 alphanumeric characters. If a chosen username is already in use, Vendo will automatically generate a random username in the format "user12345."

Usernames can also be configured to be an email address.

Cascading Between Billers and Retry Limits

Cascading between billers enables merchants to set a maximum number of retry attempts before a transaction is redirected to the next biller in line. This limit can be adjusted between 1 and 6 retries. The retry process by the biller is designed to increase the likelihood of a successful payment, particularly in cases where the initial attempt fails due to temporary issues like network errors. This approach also helps minimize delays in payment processing, ensuring a smoother and more efficient transaction experience.

Key URL Types

There are various types of URLs, each serving a different purpose within the Vendo system:

  • Public URL: The actual website URL.
  • Member URL: The URL of the members' area.
  • Success URL: The URL to which a customer is redirected after a successful payment.
  • Support URL: The URL containing customer support details.
  • Postback URL: The URL where Vendo sends postbacks.
  • Decline URL: The URL to which users are redirected if a payment fails.

Both the Success URL and Decline URL are considered redirection parameters

It’s important to note that the Decline URL is passed in the request only and cannot be pre-configured by default. If no decline URL is passed in the join link, the Success URL will be used for both successful and declined payments. If no Success URL is configured or passed, the Member URL will serve both purposes.

Updated about 2 months ago