Kartra Documentation TECHNICAL DOCUMENTATION

Payment Gateways

 Kartra integrates with four different payment gateways:

To add your payment gateways you will click My Integrations (Marked #1 Below) on the sidebar. Then you should be taken to Integrations. If not click Integrations (Marked #2 Below) in the top menu.

To make things just a bit easier, go to the drop down box and choose “Payment” (Marked #3 Below) and this will display only the four payment gateway integrations. You will see a green check-mark next to any integrations you have already set up.

PaymentGateway Update 01

PLEASE NOTE: 

These gateways involve a combination of using the specific service’s own API and the Kartra system.  This will mean some services can be corrected in Kartra while others will need to be addressed via the payment gateway.

Paypal

If you want to Kartra to process payments through your PayPal account*, you will need to integrate both platforms, and grant Kartra some permissions so it can initiate, cancel and refund transactions on your behalf.

* As per PayPal’s policies, Personal PayPal accounts cannot be used as payment gateways. You will need a Business or a Premier account.

In order to Integrate PayPal, you will want to click My Integrations (Marked #1 Below) on the sidebar. Then you should be taken to Integrations. If not click Integrations (Marked #2 Below) in the top menu.

To make things just a bit easier, in the drop down box and choose “Payment” (Marked #3 Below).  This will display only the four payment gateway integrations.

NOTE: You will see a green checkmark next to any integrations you have already set up.

Integrations Payment

Each of the Payment Gateways has their own little box. You want to click the three dots (marked #1 Below) under the “PayPal” logo.

This will pull up a black menu that will look similar to below. You want to press “New Integration” (Marked #2 Below). This will open a new popup, as displayed below.

Paypal New

Press the Connect Button (Marked #3 Above). Log into PayPal at the prompt. Be sure you are logged into your business account.

Next, you’ll see a screen similar to below. PayPal is advising you that “You are giving permission to Kartra to access specific information in your account and take actions on your behalf” which is correct and necessary to receive money. This connects your PayPal to Kartra

NOTE: If you see “Only Business or Premier Accounts can grant this permission”, it means that you’re probably running a Personal PayPal account which, as stated above, is not eligible to function as a payment gateway.

Integrations Payment Gateway Paypal Permissions

This popup should close and take you back to Kartra. And the Kartra Integration will ask for your PayPal PDT Token.

However; you will need to now login to PayPal to get your next piece of information, the PayPal PDT Token.

What is the PayPal PDT Token?

*Note that PDT Tokens are only available for Business accounts. Therefore, a Paypal Business account (as opposed to Personal) is required for the Kartra Integration.

The PDT Token is a Payment Data Transfer. This is PayPal’s secure method of transferring customer purchase data securely back to Kartra so you have a record of the transaction. Kartra needs an active PDT Token in order to be able to securely redirect your customers back to your desired Thank You page upon completing their payment in PayPal.

Paypal Create

To configure your PDT Token, log in to your PayPal account and…

  1. Click the gear icon in the top right (Marked as #1 below) of the PayPal dashboard and choose Account Settings (Marked as #2 below).
  2. Click Website payments under “Products & Services” on the left of the page. (Marked as #3 below)
  3. Click Update beside Website preferences. (Marked as #4 below)

PayPal Websitepayments 01

On the Screen that follows, turn on “Auto Return for Website Payments” (Marked #1 Below)

For Return URL, you may enter https://Kartra.com (Marked #2 Below), or indeed any URL you want. You see, Kartra will not actually read the Return URL from this field. Instead, you’ll in fact configure the redirect URL from within the Product Configuration area inside your Kartra account, and that’s the one Kartra will redirect to upon a successful payment.

Turn ON “Payment Data Transfer” (Marked #3 Below). Your PDT token may not appear until you have saved the page.

Scroll all the way to the bottom and press save.

PayPal Websitepayments 02

This will take you back to your Business Profile Settings. Now, once again you have to navigate your way back to My Selling Tools, and from there to Website Preferences (just like before).

Under “Payment Data Transfer”, you will now see the long Identity Token (see “3” in screenshot above).

Go Back to Kartra. Paste that Identity Token in the PDT Token field (see “2” below).

Now the “CREATE” Button should be green, click it to save your Payment Gateway.

Paypal Create

Your payment gateway should now be finally setup! However, there’s one last thing to do inside your PayPal account…

The Instant Payment Notification

There is one more thing that needs to be checked in order to make sure everything is working smoothly: we need to configure an Instant Payment Notification.

We need to make sure that your IPN notifications are turned ON. This is needed for Kartra to be able to track refunds, recurring payments and any of the other many notifications PayPal sends out in the background.

Let’s follow these steps:

  1. Click the gear icon in the top right of the PayPal dashboard and choose Account Settings.
  2. Click Notifications under “Business Profile” on the left of the page.
  3. Click Update beside Instant payment notifications. See screenshot below:

    211

  4. Click Choose IPN Settings
  5. Enter http://kartra.com in the Notification URL field.
  6. Select Receive IPN messages (Enabled) and click Save.

If your IPN notifications page looks like the screenshot bellow, you do not need to do anything else. The Notification URL might be different but don’t worry, that bit is not important. What really matters is that the Message Delivery is Enabled.

Set Ipn 4

In the other hand, if the Message Delivery is Disabled, or if the page shows like the screenshot bellow, then please click on “Choose IPN Settings”.

Set Ipn 2

In the next page, at the Notification URL input field, type “https://kartra.com“. Make sure the Receive IPN Messages radio button is ticked ON, and then click Save.Set Ipn 3

Now your IPN should be enabled, and the PayPal integration is finally complete!

Stripe

Stripe is an industry leader for simplicity and security in payment gateways. You will need to have a Stripe account to integrate it with Kartra. You can join Stripe at http://Stripe.com, it’s easy to apply for and use.

Kartra allows for unlimited gateways, even of the same kind, so you can add as many payment gateways as your heart desires. The only catch? You can only use one PayPal and one other credit card gateway per product. You can use a Stripe account that is connected to another cart as long as that cart does not have limitations of only their connection.

In order to Integrate Stripe, you will want to click My Integrations (Marked #1 Below) on the sidebar. Then you should be taken to Integrations. If not click Integrations (Marked #2 Below) in the top menu.

To make things just a bit easier, go to the drop down box and choose “Payment” (Marked #3 Below) and this will display only the four payment gateway integrations. You will see a green check-mark next to any integrations you have already set up.

Integrations Payment

Each of the Payment Gateways has their own little box. You want to click the three dots (marked #1 Below) under the “Stripe” logo. This will pull up a black menu that will look similar to below. You want to press “New Integration” (Marked #2 Below).

Stripe New

Now that you’ve pressed “New Integration” you’ll see a popup like below.

Stripe Create

Login to Stripe and go to “developers” and “API keys” tabs. (Marked #1 Below).

Click beside “Secret Key” on “Reveal test key token”. This will reveal the secret key that you need to use within Kartra. Copy the key.

Do not close your Stripe Tab. You will need it again in a moment.

Stripe Update 03

Choose Stripe from the Payment Gateway options from within Kartra.

Paste the Secret Key from Stripe via the above steps (Marked #1 Below).

Paste the Publishable Key from Stripe via the above steps (Marked #2 Below).

Press Create (Marked #3 Below).

Stripe Create

A new window will open.

You will see “Success. Payment gateway created successfully! Must Do: Now, you must put the following URL into your merchant account’s Instant Payment Notification configuration.”

Now go back to Stripe. You should still be on API Keys.

Stripe Success

If you are still on the Developers/API Keys tab within Stripe, you can just click “Webhooks” option (located below “API Keys” in the menu)

  • Click “Add Endpoint”.
  • In “Endpoint URL” insert https://app.kartra.com/notifications/stripe .
  • Select “receive all events”.  Note this is not in the typical drop-down and is a separate choice. As shown in image:

Stripe Update 04

  • Another note, you may receive a message saying this might be too many messages and could slow down your system.  Just accept and go through the prompts, your system will not slow down due to your settings despite this warning and it can be ignored.
  • Click Add Endpoint.

Now your Stripe Transactions should be communicated to Kartra!

Authorize.net

Authorize.net provides services to help merchants accept online and mobile credit card processing. You will need to have an Authorize.net account to integrate it with Kartra. You can join Auth.net at http://Authorize.net.

Kartra allows for unlimited gateways, even of the same kind, so you can add as many payment gateways as your heart desires. The only catch? You can only use PayPal and other credit card gateway per product.

In order to Integrate Authorize.net, you will want to click My Integrations (Marked #1 Below) on the sidebar. Then you should be taken to Integrations. If not click Integrations (Marked #2 Below) in the top menu.

To make things just a bit easier, go to the drop down box and choose “Payment” (Marked #3 Below) and this will display only the four payment gateway integrations. You will see a green checkmark next to any integrations you have already set up.

Integrations Payment

Each of the Payment Gateways has their own little box. You want to click the three dots (marked #1 Below) under the “Authorize.net” logo. This will pull up a black menu that will look similar to below. You want to press “New Integration” (Marked #2 Below).

Auth Connect

Now that you’ve pressed “New Integration” you’ll see a popup like below.

You can see, you’ll need your API Login, Transaction Key, Signature Key, and Public Client Key.

Auth Create

IMPORTANT: Be sure you have signed up for the Customer Information Manager (CIM) service. This is a new required Authorize feature to ensure PCI compliance.

Login to Authorize.net and go to Account, (Marked #1 Below), then go to “Settings” (Marked #2 Below). Next, you will scroll down to “Security Settings” and look for “API Credentials & Keys” (Marked #3 Below). Press “API Credentials & Keys”

Auth Api

The screen should look similar to below. Copy your API Login ID (Marked #1 Below).

Next, you need your Transaction Key. During the setup of your Authorize account, you created a secret question, you will need the answer to get your keys.  Below the question, click obtain “New Transaction Key” (Marked #2 Below).

Auth Api Login

The next screen will be your Transaction Key (Marked #1 Below) be sure to copy to the Transaction Key in your Kartra Integration. Once done, click “Continue” (Marked #2 Below).

Auth Api Transaction

After you press continue, you will be taken back to your Authorize Settings, repeat the process above for Your Transaction Key, but this time you need to click obtain “New Signature Key” (Marked #3 Below).

Auth Api Login

On this screen you’ll see your EXTRA EXTRA long Authorize Signature Key (Marked #1 Below). Paste the Secret Key on your Authorize.net Integration within Kartra. Then press continue

Auth Api Signature

After you obtain your Authorize Signature Key and press continue, you should be taken back to your Authorize.net Settings.

If not, click “account” (Marked #1 Below), then Settings (Marked #2 Below).

Under Security Settings, click “Manage Public Client Key”(Marked #3 Below).

Press Create (Marked #3 Below).

Auth Client

You will once again be asked your Secret Question. After you answer, you will see your Authorize Public Client Key. Copy your key and paste it into your Authorize Integration with Kartra.

Auth Client Key

Be sure you pasted your API and three different keys into the correct places on your Kartra Integration.

After you have confirmed all the information is correct and in the correct spots, press create.

Auth Create

A new window will open. The window will say the following:

“Success. Important Now, you must put the following URL into your merchant account’s Instant Payment Notification configuration. Learn How.”

 

Now go back to Authorize.net.

Auth Success

Go back to your Authorize settings. Click “account” (Marked #1 Below), then Settings (Marked #2 Below).

But this time you need to scroll lower on the page to Business Settings, click “Webhooks”(Marked #3 Below).

Auth Webhook

On the next screen, you will click “Add Endpoint” (Marked #1 Below).

Auth Webhook Add

Now you should be on the EndPoint editor. Give your Webhook a name (Marked #1 Below). Add your endpoint URL “https://app.kartra.com/notifications/authorize_net” (Marked #2 Below).

In the drop-down, change the status to “Active” (Marked #3 Below). Under “Select Events” choose “All Events” (Marked #4 Below).

Auth Webhook Editor

Now your Authorize.net Transactions should be communicated to Kartra!

Braintree

Braintree provides services to help merchants accept online and mobile credit card processing. You will need to have a Braintree account to integrate it with Kartra. You can join braintreepayments.com.

Kartra allows for unlimited gateways, even of the same kind, so you can add as many payment gateways as your heart desires. The only catch? You can only use PayPal and other credit card gateway per product.

In order to integrate Braintree, you will want to click My Integrations (Marked #1 Below) on the sidebar. Then you should be taken to Integrations. If not click Integrations (Marked #2 Below) in the top menu.

To make things just a bit easier, go to the drop down box and choose “Payment” (Marked #3 Below) and this will display only the four payment gateway integrations. You will see a green checkmark next to any integrations you have already set up.

Integrations Payment

Each of the Payment Gateways has their own little box. You want to click the three dots (marked #1 Below) under the “Braintree” logo. This will pull up a black menu that will look similar to below. You want to press “New Integration” (Marked #2 Below).

Braintree New

Now that you’ve pressed “New Integration” you’ll see a popup like below.

You will need the following and are marked as they appear in Braintree:

  1. Tokenization Key (Marked #1 Below)
  2. Public Key (Marked #2 Below)
  3. Private Key (Marked #3 Below)
  4. Merchant ID (Marked #4 Below)

Braintree Create

Visit Braintree, and click “Account” then “My User” from the drop-down (Marked#1 Below).

You will need to scroll down the page (Marked #2 Below) to find “API Keys, Tokenization Keys, and Encryption Keys” click “View Authorizations” (Marked #3 Below).

NOTE: Braintree may change their website from what appears in this document.

Braintree Keys

The first key you are going to get is your “Tokenization Key.” It may already be generated (Marked #2 Below). If not, click “Generate New Tokenization Key” (Marked #1 Below). After you see your key, please copy and paste it into your Braintree Integration Tokenization Key.

Braintree Generate Token

Scroll slightly up from Tokenization, and you will see “API Key,” but this section actually holds your three other keys, Public Key, Private Key, and your Merchant ID.

If you see a “Public Key” has already been generated click “View” (Marked #2 Below). Otherwise press “Generate New API Key” (Marked #1 Below) and then click “View” (Marked #2 Below).

Braintree Generate Api

After you press view, you will see your next 3 keys and a javascript code.

Braintree View Keys

You will need to add those three keys to your Braintree Integration.

  • Add the Public Key (Marked #1 Above) to Public Key (Marked #2 Above)
  • Add the Private Key (Marked #2 Above) to Private Key (Marked #3 Below)
  • Add the Merchant ID (Marked #3 Above) to Merchant ID (Marked #4 Below)

After you have confirmed all the information is correct and in the correct spots, press create.

Braintree Create

A new window will open. The window will say

“Success. Important Now, you must put the following URL into your merchant account’s Instant Payment Notification configuration. Learn How.”

Braintree Success

Go back to your Braintree account. Click “Settings” and from the drop-down, click “Webhooks” (Marked #1 Below).

On the webhooks page click “Create New Webhook”(Marked #2 Below).

Braintree Webhook

On the next screen, you will click “Add Endpoint” (Marked #1 Below).

Now you should be on the Webhook Creator. Add your endpoint URL “https://app.kartra.com/notifications/braintree” (Marked #1 Below).

On Notifications, click the box beside all the notifications (Marked #2 Below).

Click “save” (Marked #3 Below)

Braintree Webhook New

Now your Braintree Transactions should be communicated to Kartra!

© 2020 Kartra All Rights Reserved