Enable Interaction with 2Checkout

To activate 2Checkout gateway, you must require API Username, API Password, Seller Id, Private Key, Publishable Key and Secret Word.

  • API Username and API Password

    Follow below steps to create username:

    • Log in to your 2Checkout account.
    • Click the Account tab.
    • Click the User Management sub-tab.
    • Click +Create Username
    • Enter the required details for: email, username, and password. You should enter an un-monitored or “no-reply” email if you do not wish to receive additional email from 2Checkout regarding sales and other actions.
    • Click the API Access radio button.
    • Check the API Updating box if this username must have “write” access to your account. If you are unsure of whether or not you need this permission, refer to your cart’s support documentation, or discuss this further with your software development team.
    • Click Create Username
    • After clicking Create Username you will be sent to another form where you can enter additional details for the username – you may skip over this step entirely as your username is already created.
    • Now store your API Username & Password.

    For more detail about api username & password, please click here.

  • Seller Id (account number)

    Your 2Checkout account number (also known as: Seller Id (SID), vendor ID, merchant ID, account ID) can be found within your vendor area, and is located in the upper-right corner of the screen.

  • Publishable and Private keys

    Follow below steps to get Publishable and Private keys:

    • Log in to your 2Checkout account.
    • Click the API tab.
    • Here You will find your Publishable and Private keys.
    • Note: If you do not see your Publishable and Private keys under the API tab, this indicates your account is not approved to use the Payment API.

    For more detail about publishable and private keys, please click here.

  • Secret Word

    To set up the Secret Word, follow the steps below:

    • Log in to your 2Checkout account.
    • Click the Account tab.
    • Click the SITE MANAGEMENT sub-tab.
    • Scroll down to find the Secret Word field
    • You will be able to enter the Secret Word in the field that is under Direct Return and above the Approved URL field.
    • Click the Save Changes button at the bottom of the page.

    For more detail about Secret Word, please click here.

In order to set callback url for payment process, Go to 2CheckOut control panel:

  • Navigate to Account tab > Site Management
  • Under the Direct Return heading, you will find following options:
    • Given links back to my website (Select This Option)
    • Direct Return (Our URL)
    • Header Redirect (Your URL)
  • In the Approved URL field set the URL where you want your customer to be sent after successful Payment.

2Checkout does not support “Day” in billing cycle and free trial.

2checkout supports only first occurence of billing cycle as trial duration. So if you want to give trial,then set same parameters in “Billing cycle” and “Trial Period Duration”, otherwise plan expiration willnot work properly with 2checkout.

In Case of Automatic subscription, If total payable amount will be 0 (Zero), then 2checkout gateway will not work.

You must need to enable Instant Notification Service (INS) URL url for recurring billing.

To set up your notification URL(s) click on the Webhooks tab in your account to be directed to the Settings page. On the Settings page you may then enter a Global URL to have all notifications sent to the same URL, or you may provide a specific URL for each notification type.

Below are instructions for setting the notification URL(s) for your account.

  • Enter http://yoursite.com/?arm-listener=arm_2checkout_api URL in the Global URL field.
  • Click the orange Apply button to the right of the Global URL field.
  • To receive all notification types to that URL click the green Enable All Notifications link located above the Global URL field.
  • Click the black Save Settings link located above the Global URL field or at the bottom of the page. NOTE: After clicking Save Changes the URL will no longer be visible in the Global URL field, but will be listed in the URL field for each notification type.

ARMember_payment_gateways_2checkout