Overview

The object below is returned directly or within a successful response from the following API requests:

Retrieve a customer

Customer object

Parameters			Type/Description
AvangateCustomerReference			Int
			System-generated 2Checkout customer reference.   null when you create a new customer. The 2Checkout system generates default customer numerical (integer) IDs (AV_CUSTOMERID) automatically for all orders containing products that feature subscriptions.     Aggregate subscriptions under the same Customer account by adding the AV_CUSTOMERID (case sensitive) parameter to Buy links.
ExternalCustomerReference			String
			Unique customer alphanumeric (string) identifiers you control. Aggregate subscriptions under the same Customer account by adding the CUSTOMERID (case sensitive) parameter to Buy links.
FirstName			String
			Customer's first name.
LastName			String
			Customer's last name.
Company			String
			Company name.
FiscalCode			String
			Can be null for end users. For companies, it needs to be the VAT ID, which 2Checkout validates. 2Checkout throws an error if the VAT ID is invalid/incorrect. When present, you also need to provide the company name.   Can be null for end users.
Address1			String
			Customer's address.
Address2			String
			Customer's address.
City			String
			Customer's city.
State			String
			Customer's state. For example, "Alabama","Alaska","Arizona".
Zip			String
			Zip code.
CountryCode			String
			Customer's country code (ISO 3166 two-letter code).
Phone			String
			Customer's phone number.
Fax			String
			Customer's fax number.
Email			String
			Customer's email.
Enabled			Boolean
			true or false, depending on whether the customer account is active or inactive. An active customer account features at least one Active or Past due subscription. Possible customer statuses:   Active - Customer account status is Active even if Trial and Cancelled/Expired subscriptions exist for the customer, along as there's at least one Active subscription. Customers with a single subscription featuring the Past due status (expired but in the grace period) are considered Active. Inactive - All subscriptions associated to this Customer account are cancelled, expired or both. Trial - Customer account status is Trial if all Active subscriptions for this customer are trials, regardless of any Cancelled/Expired subscriptions.
Trial			Boolean
			true or false, depending on whether the customer account features only trials or also paid subscriptions.
Language			String
			ISO 639-1 two-letter code. Example: “en.”

Overview

The 2Checkout system sends both merchants and shoppers a variety of emails triggered by different actions they perform in the platform. Below is a list of currently available email templates sent via the Channel Manager.

Channel Manager Email Templates

Sent to Merchants

New partnership request

Informs the merchant that they have received a new partnership request that needs their review.

Email body:

Please be informed that you have received a new partnership request that needs your review.
Partner Company Name: 
Partner Country:
Contact Email: 
Website: 
To see more information regarding the partnership request and accept the application, please log in to your 2Checkout Control Panel and visit Partnership Management – Partners section:

Order placed by partner

It notifies the merchant that an order has just been placed by a partner.

Email body:

Please be informed that a new order was placed by [PARTNER_COMMERCIAL_NAME].
Order Details
Partner Commercial Name: 
Order Reference: 
Order Total Amount:
Order Status: 
To approve this order please log in to your 2Checkout Control Panel:
To see more information regarding this order, please log in to your 2Checkout Control Panel:

Best regards,
The 2Checkout Partner Team

Vendor partner threshold notification

Email sent by the system to the merchant to inform them about the list of partners that can be switched to a new partnership program based on reaching a threshold.

Email body:

Hello,

This is an automated notification sent out for [ACCOUNT_NAME].
Since our last notification, the following partners have reached the thresholds you set and now qualify for a new partnership program.
The following partners have reached the thresholds you set and now qualify for a new partnership program.
Please find below the corresponding information: 
Partner code: 
Partner company name: 
Partnership program the partner qualifies for: 
Total amount of complete orders: 
Total number of complete orders:

Thank you,
2Checkout Team

Cancel Invoice

Email notification informing partners about the cancelation of the proforma invoice.

Email content:

The partner invoice [ProformaNumber] / [DateFormated] was cancelled by [COMPANY_NAME].

The orders in a cancelled partner invoice need to be added into a new partner invoice before being paid.
For more information regarding the cancellation of this partner invoice, please contact [COMPANY_NAME] at ....

Cancelled Partner Invoice Information

Partner Invoice No.: 
Total Amount: 
Partner Commercial Name: 
Vendor Commercial Name: 
Due Date:
Order Reference No.: 

Sent to Partners

Confirm Address To Old Email

Email address change notification sent by the Partner Control Panel. 

Email body:

Dear ....,

You are receiving this message because we recently recorded a request to change the login email address for the [PAYMENT_PARTNER] Partner Control Panel you are using in relationship with [MerchantCommercialName].

Old email address: 
New email address: 

To continue with the new login address, just ignore this message.  

If you want to cancel this request and restore the login with the old email address, please follow the link below:

[RESTORE_EMAIL_ADDRESS_URL]

To avoid truncated link errors, paste the entire link above into your web browser.

The link will expire in 30 days.

Direct Renewal

An email informing partners that the Direct Renewal program was enabled for their account by the merchant.

Email body:

Dear [PARTNER_NAME],

The [PAYMENT_PARTNER] Direct Renewal program has been enabled for your account by [VENDOR_NAME].

Log into the Partner Control Panel and activate Direct Renewal now to start benefiting from:
* Automated subscription renewals for your customers;
* Protected profit margins for renewals;
* Streamlined renewal management.

Take advantage of this program to receive margins for the subscriptions your customers renew directly through [PAYMENT_PARTNER] or [VENDOR_NAME] website. The margins you’ll receive are based on the Direct Renewal margins detailed below:

End-User Registration

Email sent to end-users, asking them to register their Avangate licenses.

Email body:

You have recently placed an order for the following product(s)/service(s):
To complete your order and gain access to the full product experience, please register by using the link below:
Product / Service registration is delivered to you by [PAYMENT_PARTNER], on behalf of [Merchant.CommercialName].

Keys to End-user

Email sent to end-users listing activation keys.

Email body:

Please find below the activation information for your product(s) /service(s).
Activation key: 
Attachment file: 
The customer reference corresponding to this transaction is: [product.CUSTOMER_REFERENCE]
Product/service keys are delivered to you by [PAYMENT_PARTNER], on behalf of [Merchant.CommercialName].
For any product / service installation, activation and other technical support issues, please contact:
Please keep this email for future reference.
Best regards,

Keys to Partner

Email notification sent by the platform providing partners with activation information for the purchases product/service. 

Email body:

Please find below the activation information for the product(s) /service(s) purchased through order #[REFNO]
Activation key: 
Attachment file: 
The customer reference corresponding to this transaction is: 
Product/service keys are delivered to you by [PAYMENT_PARTNER], on behalf of [Merchant.CommercialName].
For any product / service or commercial related questions, please contact:
Please keep this email for future reference.

New Invoice

Email sent by the 2Checkout Financial department to inform partners that a new invoice was issued for their account by the merchant.

Email body:

A new partner invoice was issued for your account by [CompanyName].
To view your partner invoice, please log in to your control panel:
Partner Invoice Information
Partner Invoice No.: 
Total Amount:
Due Date: 
Order Reference No.: 

New Partner Contact Notification

Email notification informing partners that a new Partner Control Panel account was created for them, upon request from the merchant.

Email body:

Dear Partner,

We are happy to inform you that a new Partner Control Panel account (powered by [PAYMENT_PARTNER]) has been created for you, upon request from [Merchant.CommercialName].
You can use your new account to place orders and manage the relationship with [Merchant.CommercialName].
To place orders and manage the relationship with [Merchant.CommercialName], you need to use the new Partner Control Panel account (powered by [PAYMENT_PARTNER]) that was created for you.
Please use the details below to log in to your new Partner Control Panel account:
Login email: [PartnerContact.Email]
Password: To setup your password, access the following link:
Login URL:

Order Cancel to Partner

Email notification informing the partner that their order was canceled by the merchant.

Email body:

Please note that your order [REFNO] was cancelled by [VENDOR_COMMERCIAL_NAME].
Order Details:
Order Date:
Order Total Amount: 
Product(s)/Service(s) in order:
To see more information regarding this order, please log in to your Partner Control Panel:

Order Edit to Partner

Email sent by the platform informing partners that their order was edited by the merchant.

Email body:

Please be informed that your order [REFNO] was edited by merchant.

Order Details:
Comment: 
New Order Total Amount: 
Order Date: 
Product(s)/Service(s) in order:
To see more information regarding this order, please log in to your Partner Control Panel:

Partners Order Placed by Merchant

Notification sent to partners about a new order that was added to their account by the merchant.

Email body:

Please be informed that a new order has been added for your account by [VENDOR_COMMERCIAL_NAME].
Order Details
Order Reference No.: 
Order Total Amount: 
Order Status:
To see more information regarding this order, please log in to your Partner Control Panel:

Partners Renewal License

This is a renewal notification for partners.

Email body:

Please find attached the report regarding the subscriptions that are about to expire or have already expired.
To add a renewal order, just log in to your Partner Control Panel and choose to renew the subscriptions.
For more information, please contact [VENDOR_NAME] at [VENDOR_EMAIL].

Partner Confirmation Notification to Partner

Email sent to partner after approval/decline of their partnership application from the Merchant Control Panel.

Email body:

Dear ...,
Your partnership application with [Merchant.CommercialName] has been approved.
Please use the details below to log in to your Control Panel.
To setup your password, access the following link:
Login URL:
Login email: [PartnerContact.Email]

Or...

We regret to inform you that [Merchant.CommercialName] has declined your partnership application. For more information on this topic, please contact [Merchant.PartnersAutomaticEmail].

Partner Signup Notification to Partner

Email sent to the partner after submitting their partner registration form.

Email body:

Dear ...,

Thank you for your interest in becoming a partner with [Merchant.CommercialName]!
Your application has been submitted for approval to [Merchant.CommercialName].
Once your request has been approved, you will receive an automated email with details about your account information.
If you have any questions, please do not hesitate to contact [Merchant.CommercialName] by email.

Proforma Notification

Proforma Invoice status information sent by the 2Checkout Financial department when the Notify partner button is clicked.

Email body:

Please see below the latest information about the partner invoice: 
Partner Invoice Information
Current Status:
Total Amount: 
Partner Commercial Name: 
Vendor Commercial Name: 
Due Date: 
Order Reference No.: 
To view your partner invoice, please log in to your Control Panel:

Recover Pass

Notification sent by the platform upon password recovery request.

Email body:

Dear [PAYMENT_PARTNER] customer,

You are receiving this message because you have requested to recover the login password to the [PAYMENT_PARTNER] Control Panel.
In order to reset your password, please access the following link:
This link will expire in 24 hours.
If you have not requested the recovery of your password, please ignore this message.

Refund Process Status

Email sent to partner by 2Checkout Financial department with details about the refund process.

Email body:

A refund request has been sent by [REFUND_PARTNER_NAME] with the following details:
Partner invoice [REFUND_PROFORMA_NUMBER] was refunded by [REFUND_VENDOR_NAME].
For more information regarding the refund of this partner invoice, please login in to your Control Panel or contact [REFUND_VENDOR_NAME] at [REFUND_VENDOR_EMAIL].
Partner Invoice No.: 
Refund type: Total
Amount requested: 
Partner Commercial Name:
Refund request date: 
Amount refunded: 
Refund Date: 
Order reference number(s): 
In order to view full details of this refund request, please login to your Vendor control panel.
1. Go to [VENDOR_LOGIN] and log in using your email address and password.
2. From Orders & Customers - Refunds, you can manage, approve, and reject refund requests.
Additional comments from your partner:
Additional comments from [COMPANY_NAME]:

Refund Status

Email sent to the partner by the 2Checkout Financial department with the status of the requested refund.

Email body:

Please find below the information about your refund request for partner invoice [REFUND_PROFORMA_NUMBER] / [REFUND_PROFORMA_DATE]:
Refund request status: 
Amount requested:
Refund granted: 
Refund approval date
Refund denied on: 
Order reference number(s): 
Additional comments from [COMPANY_NAME]:

Reset Partner Contact Password

Notification sent to the partner by the platform upon password reset request.

Email body:

Dear partner,
Your Partner Control Panel password has been reset. Please use the link below to set up your new password:
This link will expire in 24 hours.
The new password must meet the following criteria:
- Must have at least 8 characters
- Must have at least 3 out of the following 4 character groups: lower case letters, upper case letters, numbers, special characters (ex: !,@,#,$)
- Must be different from the last password

Users Renewal License

Renewal notification sent to end-users (when direct renewal is active).

Email body:

Dear ...,

Please note that your [PRODUCT_NAME] has expired or is about to expire on [LICENSE_EXPIRATION_DATE].
In order to continue using [PRODUCT_NAME] after this date you need to renew your subscription.
For more details, please contact:
[PARTNER_NAME]
[PARTNER_WEBSITE]
[PARTNER_EMAIL]
[PARTNER_PHONE_NUMBER]

Partners User-Activated Email

Email sent by the platform to let partners know that their user account is active and they need to set a password.

Email body:

Dear ...,

Your partner user account is now active. Click the following URL to set a secure password.
The link expires in ... hours.

Best regards,
Partner Team

Partner Grace Period Approach 

The email informs partners that payment is due in 3 days for the partner invoice. It's sent by 2Checkout's Financial department.

Email body:

According to your Partnership Details and to avoid incurring any late penalties, Partner Invoice [% $PROFORMA.Details.ProformaNumber%] is to be paid in [% $dueIn %] days.
To view this partner invoice, please log in to your Partner control panel:
Partner Invoice Information
Partner Invoice Reference: 
Total Amount: 
Vendor Commercial Name: 
Order Reference: 

Password About to Expire Partners 

It notifies partners that their password is about to expire.

Email body:

Dear ...,

Your partner user account password expires in ... day(s), on ....
Once it expires, you won’t be able to access your account.
To avoid access issues, please update your password before it expires by accessing the folowing URL:
Should you have any questions related to your account, don’t hesitate to contact us.

Send expiration notification for usage-based subscriptions

Sent by 2Checkout Support to notify partners that subscription usage data needs to be uploaded before expiration.

Email body:

FOR:
[%$REPORT.CompanyName%]
[%$REPORT.ContactPerson%]
[%$REPORT.Street%]
[%$REPORT.City%]
--
Dear [%$REPORT.ContactPerson%],
Please upload usage data for the subscriptions listed below ahead of their respective expiration deadline. 2Checkout will renew usage-based subscriptions and charge your customers after you provide the data on the metered resources consumed. 
[% $REPORT.LICENSES %]
Usage can be uploaded via the Control Panel or transmitted through the 2Checkout API, ensuring that customers are charged and subscriptions renewed when due. 
Thank you for choosing 2Checkout solutions.
[%$REPORT.BusinessCompany%]
[%$REPORT.BusinessStreet%]
[%$REPORT.BusinessZip%], [%$REPORT.BusinessCity%], [%$REPORT.BusinessCountry%]
http://www.avangate.com
----
This message is confidential. It may also be privileged or otherwise protected by work product immunity or other legal rules. If you have received it by mistake please let us know by reply and then delete it from your system; you should not copy the message or disclose its contents to anyone.

Refund for Partner Invoice

It notifies the partner about their invoice refund.

Email body:

 

Use the variables in the list below to customize the Refund approved shopper email according to your needs. Check the 'Mandatory' column to see the variables that are required in your customized version of the e-mail.

Variable name	Description	Test value	Mandatory
AVANGATE_LOGO	Avangate logo URL	https://secure.avangate.com/images/e...endor_logo.png	Yes
BUSINESS_COMPANY	Avangate company name	0	Yes
CURRENCY	Order billing currency	USD	Yes
ENCRYPTED_MERCHANT_CODE	Encrypted merchant code	0	No
PAYTYPE	Identification number for the payment method selected during ordering process	CC	No
PRODUCTS[index1].CODE	Product code.	P_CODE	No
PRODUCTS[index1].SKU	Product SKU	SKU1234	No
REFNO	Order reference number	[9xxxxxx]	Yes
SELLER_BUSINESS_COMPANY	Merchant commercial name	Seller company	No
SELLER_SITE	Order website	http://www.software-company-website.com	Yes
SHOPPER_NAME	First name and last name of the shopper associated to the refund order	[John Doe]	No
TOTAL_AMOUNT	Total refund amount	56.5	Yes

 

 

Overview

We have improved the way vendors use our APIs and webhooks and added an easy way to monitor historical records of events. By using the API & webhooks log monitor you can get detailed reports on API methods, webhook and SalesForce Connector events. The report logs both:

• Successful events
• Failures

These reports will prove to be very useful when you need to troubleshoot certain issues that you encounter while using our API, webhooks or SalesForce Connector. They can help you identify different problems so you can find a solution as soon as possible.

How do I enable the API & webhooks log monitor?

1. Go to Account Settings
2. Click Manage user access
3. Select View roles and click the Edit button for the role that you want to enable the API & webhooks log monitor for.
4. Under the Orders & Reports roles section, check the API Logs checkbox and click Save role at the bottom of the page.

You will now see the API & webhooks log monitor in the Reports menu.

API logs

Follow the steps below to see the reports on the API activity.

1. Go to the Reports center menu and click API & Webhooks.
2. Choose the type of report.
3. Select API from the Event source section. Customize the report details according to your needs, including:
   
   1. The time interval for which you need to generate the report.
   2. A certain API method.
   3. Successful or failed events (or both).
   4. Choose the desired event status from the Status dropdown box and click Search once you're done configuring the report settings.

Select the Failed status to generate a report with the failed events if you need to troubleshoot specific situations or errors that have occurred while using the API.

The report shows you the date and time of the events, their duration, the IP address they were generated from, the request type and the API method that was called. You can export the report as a CSV file by clicking the Export as CSV button at the upper right side of the table. The report displays a maximum of 500 sessions starting with the most recent one detected in the selected time interval.

By clicking the called method name you can see the cronological order of the methods called during that session.

If you want specific information about each event, you can click the Info button at the right side of each row.

You can see an example of an Info box for an event below.

Webhooks logs

Follow the steps below to see the reports on the webhooks activity. The webhooks you can generate reports on are:

• Instant Payment Notification (IPN)
• License Change Notification (LCN)
• Instant Refund Notification (IRN)
• 2Checkout Delivery (EL_DEL)
• Instant Delivery Notification (IDN)
• Instant Notification Service (INS)

1. In your cPanel Dashboard, navigate to Reports center → API & Webhooks.
2. Select Webhooks from the Event source section, as shown in the image below. Customize the report details according to your needs. Select the time interval for which you need to generate the report, the web hook that you want to generate the report for and the status of the web hook. You can choose to display successful events, failed events or both.

Select the Failed status to generate a report with the failed events if you need to troubleshoot specific situations or errors that have occurred while using the webhooks.

After you click Search you can see the detailed report displayed in a table. The report shows you the date and time of the webhooks, their type, the message they have generated and their status.

You can also export the report in CSV format by clicking the Export as CSV button. The report displays a maximum of 500 sessions starting with the most recent one detected in the selected time interval.

1. If you want to generate reports for a specific webhook, click the Add filter button and the additional information required.

For IPN/IRN/EL_DEL/IDN, you can add as filter the order reference number generated by 2Checkout. In the case of LCN, you can filter the results by using the license code or the dispatch reason (change in license that determined the LCN to be sent).

If you want specific information about a webhook event, you can click the Info button at the right side of each row.

SalesForce Connector logs

Follow the steps below to see the reports on the SalesForce Connector activity.

1. Select SalesForce from the Event source section. Customize the report details according to your needs. Select the time interval for which you need to generate the report and the status of the Connector events. You can choose to display successful events, failed events or both.
2. After you click Search you can see the detailed report displayed in a table. The report shows you the date and time of the connections, their type, the message they have generated and their status.

You can also export the report in CSV format by clicking the Export as CSV button. The report displays a maximum of 500 sessions starting with the most recent one detected in the selected time interval.

1. If you want to generate reports for a specific subscription, click the Add filter button and enter the order or subscription reference that you are searching for.

Important: Select the Failed status to generate a report with the failed events if you need to troubleshoot specific situations or errors that have occurred while using the connector.

Select the report time zone

The data registered into 2Checkout's databases are registered with a timestamp that reflects the 2Checkout time zone (Romania's time zone). When you generate API and webhooks reports you have the option of generating them according to the time zone that your vendor account is configured on.

Select the desired time zone from the Report time zone drop-down menu.

Overview

Merchants that use a PSP business model (2Sell, 2Subscribe packages) are required to handle their own taxes (both calculation and remittance to local authorities) according to the merchant's applicable fiscal laws. 2Checkout offers a tax calculator service for PSP merchants to help them collect taxes in order to be compliant at the transaction level with applicable fiscal laws. 

Availability

The tax calculator is available for merchants that use the PSP business model (2Sell, 2Subscribe packages). For eligibility and activation Contact 2Checkout.

Assumption and Disclaimer

2Checkout assumes that the merchant's data is accurate, complete, reliable, error-free, and up-to-date.

The calculator’s purpose is to apply, calculate, and collect taxes on order level based on merchant tax info. This calculator and service are not meant as professional financial advice and we encourage you to seek professional advice for setting your tax compliance scheme properly.

2Checkout, its agents, officers, and employees make no representations, express or implied, as to the accuracy of the tax applicable at the order level and its applicability and suitability to the merchant's circumstances.

Workflow

1. Merchants who want to activate this feature can send an email request to the 2Checkout Financial Operations department.
2. Merchants need to submit a file with all applicable taxes they need to collect at the transaction level with the shopper.
3. 2Checkout applies and calculates the taxes at the transaction level according to the information received from the merchant.
4. The merchant is fully responsible for the tax info provided to 2Checkout. The tax information sent by the merchant needs to is accurate, complete, reliable, error-free, and up-to-date. Besides tax collection for the merchant's communicated tax data and payment of the collected taxes to the merchant, 2Checkout disclaims all warranties and responsibilities. 
5. Merchants receive the collected taxes from 2Checkout as per the payment arrangements agreed in the agreement.
6. Merchants need to further declare and pay the taxes to the appropriate tax authorities according to applicable fiscal laws.
7. 2Checkout will apply and collect the taxes per order (e.g. sales taxes or VAT value) and further remit the collected taxes in the payout/settlement with the merchant.
8. Merchants can see detailed reporting on tax calculation through the Order Export functionality (available in the 2Checkout Merchant Control Panel, as shown in the image below), Account Balance section in the 2Checkout Merchant Control Panel, through APIs per order, Payout Report, and Netsuite.

 

The attributes that can be configured for the PSP tax calculator are based on the country and/or Zip Code and include:

• VAT instant validation (through VIES)
• Product type and additional items added to the order - impacting the tax computation (e.g. IOT product together with a gift)
• Mandatory information can be collected (e.g. CIF in Brazil, GST in India and Australia) 
• GST, ABN, VAT (other than EU) are validated against our internal rules

Merchant flow

There are no special actions that merchants need to set on their side. The merchant navigates to the 2Checkout Merchant Control Panel, adds a new product and generates a new buy-link for the product using the Generate link option. 

VAT/Sales tax display

The collected taxes are displayed in any Control Panel report once 2Checkout starts collecting them and merchants will be able to see what taxes were collected on any order.

The option to display VAT/ Sales tax is also available on each report template.

Shopper flow

Tax exemption will be applied only if tax cart validation rules are met. For example, if a German B2B shopper with a valid VAT ID places an order, in the checkout process the VAT will no longer be applied, as shown in the images below.

 

 

Overview

Stock keeping unit or SKU is a number assigned to a particular product by a digital or physical retail store for easy identification and inventory tracking purposes. The SKU number is a string of alphanumeric characters that uniquely identify details such as price, product options, and manufacturer of a particular product or service. SKUs are used in order notifications, electronic delivery, export files, etc.

SKU Management

For companies that manage large product catalogs with defined SKUs and that make regular changes to their prices and products (new versions, new options), the manual process performed in the Merchant Control Panel needs to be supported by an automatic solution as well. By using an automated flow, merchants decrease the time needed for this process, and also reduce the risk of human errors associated with the manual process.

In the 2Checkout platform, SKUs can be associated with a unique combination made up of:

• Product identification element
• Pricing configuration
• Plus minimum one of the following:
  • Currency – defined as applicable to all currencies or only to specific ones
  • Volume Discounts – defined as specific quantity or intervals (applicable only according to the volume discounts that are defined at pricing configuration level)
  • Purchase Types – possible values: new purchase, renewal, upgrade, and trial
  • Pricing Options – will be available considering the pricing option groups assigned to the selected pricing configuration

 

 

 

Overview

Your shoppers have access to the 2Checkout myAccount customer portal where they can view information about the orders/transactions they performed using our platform, they can download keys/invoices if applicable, and even manage automatic renewal and payment-related information for their recurring subscriptions.

Availability

All shoppers have self-service and free access to the 2Checkout myAccount portal, regardless of the business model that merchants have chosen to use when partnering with us and regardless of the commercial terms applied.

The only requirement is to have at least one order placed using the myAccount platform or at least one subscription managed through the 2Checkout platform.

How to access 2Checkout myAccount

There are two ways to access the 2Checkout myAccount customer portal:

1. Shoppers can use the link that takes them to the customer portal (https://secure.2co.com/myaccount/ or a customized link if you use a custom domain)
2. You can redirect and log in shoppers automatically from your system into their myAccount customer portal, based on the subscription/customer reference number via Single Sign-On, an API-based method.

Access the myAccount Customer Portal by using a link

The link (https://secure.2co.com/myaccount/) shoppers need to use to access myAccount is included in the automatic emails that the 2Checkout system sends after several events/actions, such as order or payment confirmation/receipt, electronic delivery, renewal reminders, follow-ups for unfinished automatic charges, etc.

If you customize your shopping cart or your emails, you can also include this link wherever you feel it is relevant for your shoppers.

If you use a custom domain, part of this link will be replaced with your domain (e.g. https://store.custom.com/myaccount/).

How can shoppers log in into the myAccount portal

Once clicked, the link takes shoppers to the myAccount portal access page, where they have two options:

1. Log in using either the email address associated with the order/subscription in our platform or the reference number for the order placed through our platform (without the need to set a password). To do so, shoppers need to:

• Fill in either the email address or the order reference number.
• Click on the Send access link action button (an email will automatically be sent to the email address if this is associated with an order/subscription in our platform).
• The email includes an access link that logs the shopper straight into the 2Checkout myAccount (for security reasons, the link is valid for 1 hour and can be used one time only)
• Once logged in, shoppers have the option to set a password (by accessing the Manage password tab on the menu).

 

 

2. Log in using the email address (associated with the order/subscription in our platform) and a password. To do this, shoppers need to:

• Have previously set a password for the 2Checkout myAccount portal.
• If they forget the password, shoppers can click on the Forgot your password link, which will redirect them to the flow described at #1 above (where an access link is sent to the email address).

Access the 2Checkout myAccount shopper portal via Single Sign-On

You can redirect and log in shoppers automatically from your website to their 2Checkout myAccount based on subscription information or customer reference number (either from the 2Checkout system or external customer reference number) by using the Single Sign-On API call.

This is useful if you already have a customer portal on your website and only need to direct shoppers to the 2Checkout myAccount shopper portal to specific pages (such as subscriptions or subscription listing, order look-up, payment methods, manage password, etc.).

For detailed information on how to do this, check the API Integration area.

 

Use the variables in the list below to customize the Trial canceled shopper email according to your needs. Check the 'Mandatory' column to see the variables that are required in your customized version of the e-mail.

Variable name	Description	Test Value	Mandatory
ALLOW_MYACCOUNT_PROMO	Include or exclude myAccount information in the email body	1	No
BASE_URL	Merchant's full host	https://secure.avangate.com	No
BUSINESS_COMPANY	Avangate company name	Avangate	No
BUSINESS_SUPEMAIL	Avangate support email address	support@avangate.com	No
COMMERCIALNAME	Merchant's commercial name	[Software Company Name]	No
ENCRYPTED_MERCHANT_CODE	Encrypted merchant code	0	No
FIRSTNAME	Shopper's first name used on the delivery information	[John	No
LANGUAGE	Order language (abbreviated) selected by shopper	en	No
LASTNAME	Shopper's last name used on the delivery information	Doe]	No
PRODNAME	Product name	[Test product name]	No
PRODUCTS[index1].LICENSE_TYPE	Type of purchased subscription	0	No
TECHEMAIL	Merchant support email address	support@software-company-website.com	No
TECHPHONE	Merchant support phone number	[888-xxx-xxxx]	No
TRIALEND	Expiration date of trial licence.	[Trial expiration date]	No
USER_EMAIL	Email address used by shopper to login/signup to myAccount	example@customer-email.com	No
WEBSITE	Website where the shopper placed the order	http://www.software-company-website.com	No

Overview

Use the object below to create, update and retrieve customers in 2Checkout.

Input parameters

Parameters			Type/Description
ExternalCustomerReference			Optional (string)
			Unique customer alphanumeric (string) identifiers you control. Aggregate subscriptions under the same Customer account by adding the CUSTOMERID (case sensitive) parameter to Buy links.
FirstName			Required (string)
			Customer's first name.
LastName			Required (string)
			Customer's last name.
Company			Optional (string)
			Company name.
FiscalCode			Optional (string)
			Can be null for end users. For companies, it needs to be the VAT ID, which 2Checkout validates. 2Checkout throws an error if the VAT ID is invalid/incorrect. When present, you also need to provide the company name.   Can be null for end users.
Address1			Required (string)
			Customer's address.
Address2			Optional (string)
			Customer's address.
City			Required (string)
			Customer's city.
State			Optional (string)
			Customer's state. For example, "Alabama","Alaska","Arizona".
Zip			Required (string)
			Zip code.
CountryCode			Required (string)
			Customer's country code (ISO 3166 two-letter code).
Phone			Optional (string)
			Customer's phone number.
Fax			Optional (string)
			Customer's fax number.
Email			Required (string)
			Customer's email.
Enabled			Optional (boolean)
			true or false, depending on whether the customer account is active or inactive. An active customer account features at least one Active or Past due subscription. Possible customer statuses:   Active - Customer account status is Active even if Trial and Cancelled/Expired subscriptions exist for the customer, along as there's at least one Active subscription. Customers with a single subscription featuring the Past due status (expired but in the grace period) are considered Active. Inactive - All subscriptions associated to this Customer account are cancelled, expired or both. Trial - Customer account status is Trial if all Active subscriptions for this customer are trials, regardless of any Cancelled/Expired subscriptions.
Trial			Optional (boolean)
			true or false, depending on whether the customer account features only trials or also paid subscriptions.
Language			Optional (string)
			ISO 639-1 two-letter code. Example: “en.”