Standard Join link

site

integer

yes

Your site ID, assigned by Vendo.

• *Example:** 2

page

string

no

The page the user should start on.
join for single-page process or prejoin for 2-step process.

country

string

no

Country the user resides in.

• *Note:** Since the country is autodetected by Vendo, you do not need to include this parameter and we strongly recommend against using it.

2-letter ISO country codes.

• *Example:** gb
• *Default:** End user's country as determined from the IP address.

See a list of all ISO country codes

language

string

no

Language the user prefers.

• *Note:** Since the language is autodetected by Vendo, you do not need to include this parameter and we strongly recommend against using it.

2-letter ISO language codes.

• *Example:** en

Default: Preferred language as defined in end user's web browser.

See a list of all ISO language codes

billing_currency

string

no

This parameter allows you to force and block the display and billing currency shown to the end-user.

USD, EUR and GBP are the only supported values.

Note:
If the billing_currency param is set, the url must be signed (see signature parameter).

3-letter ISO 4217 format

mdo_id

integer

no

This parameter allows you to apply a % discount to all displayed offers to the end user. Contact us to receive a list of discounts that have already been created.

If the mdo_id param is set the url must be signed (see signature parameter).

signature

string

no

The URL signature.

For more information, see Signing URLs

email

string

no

Prefill the "Email" field.

Example:
[email protected]

username

string

no

Prefill the "Username" field.

• Example:_ Joe

password

string

no

Prefill the "Password" field.

• *Note:** Please see the password_encrypted parameter and consider encrypting the password before sending it.
  To encrypt the password you can use our PHP SDK._
• *Note:** If you don't need customers to enter a password before making a payment, send password=ignore and password_hide=1
• Example:* mypassword

password_encrypted

boolean

no

Use this parameter to indicate that the password parameter is encrypted.

• Example:_ password_encrypted=1&password=encryptedpassword

The password will be decrypted by Vendo to show it to the user in the confirmation page, confirmation email, or the customer portal.

Accepted values:

• 0 - password is not encrypted (default).
• 1 - password is encrypted.

email_hide

boolean

no

Hide the "Email" field.

• Example:_ 1
• Default:_ 0

Note:
You must supply the email using the email parameter if you intend to hide the "Email" field!

username_hide

boolean

no

Hide the "Username" field.

• Example:_ 1
• Default:_ 0
• *Note:** If the username field is hidden you must supply the username value.

password_hide

boolean

no

Hide the "Password" field

• Example:_ 1
• Default:_ 0
• *Note**: If the password field is hidden you must supply the password value. If your customers don't need a password to pay, send password=ignore

subscription

integer

no

Unique Vendo subscription ID of the end user to whom the standard join is being advertised.

We will use the user details from the subscription and we will reduce the number of fields on the join form to the minimum.

If the subscription param is set the url must be signed (see signature parameter).

firstname

string

no

Prefill the "First Name" field.
Example: John

lastname

string

no

Prefill the "Last Name" field.
Example: Smith

street

string

no

Prefill the "Street" field.
Example: 123 My St

• *Note:** This field is hidden by default. Let us know if you need to display it in your payment process.

city

string

no

Prefill the "City" field.
Example: San Francisco

• *Note: **This field is hidden by default. Let us know if you need to display it in your payment process.

zip

string

no

Prefill the "Zip" field.
Example: 94114

• *Note:** This is for US zip codes, if required by law

state

string

no

Prefill the "State" field.
Example: California

Notes:

• This is for US states, if required by law.
• This field is hidden by default. Let us know if you need to display it in your payment process.

offers

integer

no

Limits the list of offer the customer can choose from.

Can be a single offer ID or a list of offer IDs separated by comma.

If this parameter is not passed in then the default offers configured for a site will be displayed.

The order of the IDs in the list will define the order on the page.

Example: offers=1001,1002,1003

selected_offer

integer

no

Choose which offer should be preselected.

Example: selected_offer=1002

xsales_max

integer

no

Number of cross-sale offers to be displayed on the payment page.

Accepted values
0 - Do not display any cross-sales
1 - Display only 1 cross sale
2 - Display 2 cross sales.

• Default value:_ 2

xsales

integer

no

List of cross-sale IDs to be displayed on the payment page.

Example:
xsales=1102,1104

• Default:_ If not specified, the first two cross-saless configured in Vendo's back office will be displayed.

xsale_ref

string

no

Your transaction reference values for any xsale transactions processed.

Comma separate the values if you have different reference values for each cross sale.

Vendo's platform will post these references in the transaction postbacks.

Example:
xsale_ref=MYCSREF1,REF2

decline_url

string

no

Redirects the end-user to this URL if the transaction failed (i.e. payment was not successful)

• Note:_ Make sure this parameter value (like all url parameters values) is url-encoded.

Example:
https://mysite.com/decline_page?user_email={EMAIL}&passthru_reference={REF}

then url-encode it, this is how that example looks like after url-encoding it,

https%3A%2F%2Fmysite.com%2Fdecline_page%3Fuser_email%3D%7BEMAIL%7D%26passthru_reference%3D%7BREF%7D

success_url

string

no

Redirects the end-user to this URL if the transaction was successfully processed. (i.e. the payment was accepted)

• Note:_ Make sure this parameter value (like all url parameters values) is url-encoded.

Example:
https://mysite.com/success?user_email={EMAIL}&vendo_subscription_id={SUBSCRIPTION_ID}&passthru_reference={REF}&selected_offer_id={SELECTED_OFFER}&vendo_transaction_id={TRANSACTION_ID}

then url-encode it, this is how that example looks like after url-encoding it,

https%3A%2F%2Fmysite.com%2Fsuccess%3Fuser_email%3D%7BEMAIL%7D%26vendo_subscription_id%3D%7BSUBSCRIPTION_ID%7D%26passthru_reference%3D%7BREF%7D%26selected_offer_id%3D%7BSELECTED_OFFER%7D%26vendo_transaction_id%3D%7BTRANSACTION_ID%7D

{EMAIL}

The end-user's email address.

{USERNAME}

The end-user's username.

{PASSWORD_ENCRYPTED}

The end-user's encrypted password.
Uses AES-128 encryption with your personal shared secret,you can use our PHP SDK to encrypt the password.

{PASSWORD}

The end-user's password.
Deprecated - use {PASSWORD_ENCRYPTED} instead.

{FIRSTNAME}

The end-user's first name.

{LASTNAME}

The end-user's last name.

{STREET}

The end-user's billing address street.

{CITY}

The end-user's billing address city.

{ZIP}

The end-user's billing address zip code.

{COUNTRY}

The end-user's billing country.

{REF}

Your transaction reference.

{SUBSCRIPTION_ID}

Vendo Subscription ID. This is only available for the success_url.

{TRANSACTION_ID}

Vendo Transaction ID

{OFFER_IDENTIFIER}

Your offer reference.

{SELECTED_OFFER}

Offer ID for the selected offer.

{ERROR_CODE}

Vendo error code

logindata_hide

boolean

no

Hides the username and password credentials on the confirmation page.

Examples:
1 - Hide the information
0 - Show the information (default)

ref

string

no

The data that will be reported for the transaction event.

Maximum 1024 characters.
Example:
123456

Will be reported back to you in the postbacks in the merchant_reference parameter.

affiliate_id

string

no

Affiliate identifier.
Please provide this parameter so Vendo can provide you reporting on your affiliates performance.

Example:
XMjc4MzUxOjM

Important
Please use 0 (zero) for organic and search engine traffic.

campaign_id

string

no

Campaign identifier.

Example:
159

program_id

string

no

Program Identifier.

Example:
277

pm

string

no

Pre-selects a payment method.

The checkout page will have the specified payment method pre-selected from the dropdown if it's valid for the selected country and offer.

Values:
cc = Credit Card (default)
pi = Pay by Bank
sepa = SEPA
pg = PayGarden
in = Interac
pix = PIX
crypto = Crypto
paypal = PayPal
oxxo = OXXO

Example:
pm=pi

• • Note that some payment methods may not be supported by Vendo in a given scenario. Only options that appear the the payment method dropdown can be preselected._ Please read the notice below this table.

site_name

string

no

This is the name of the site using your whitelabel solution.

We'll render this name in the payment page.

site_url

string

no

This is the URL of the site using your whitelabel solution.

We'll use this URL together with the site_name in the confirmation page and any future communication that our platform will send via email, for example in the payment confirmation email.

Note:
The site URL must be url -encoded.