API Integrations¶
Setup Integrations API
API Integrations are configured to allow ConnexCS to connect to external services. For inbound APIs, please see the API in the Architecture documentation.
Available Integrations¶
PayPal Express Checkout Allows online checkout via the customer portal using a PayPal Account.
PayPal IPN Enable IPN to use MassPay or to send money from the PayPal portal without using your site. This also notifies the system of incoming PayPal payments and we can top-up based on that notification.
Stripe Possibly the world's best credit card processor, Stripe can be made available on your customer portal.
Duo Security With Duo Security we can provide 2FA (2 Factor Authentication) via an out-of-band push notification to your mobile device to approve login. It also provides fingerprint authentication for extra security.
Moneris Moneris is Canadian Credit Card Processing service.
ScriptForge ScriptForge is the ConnexCS JavaScript Sandbox environment where you can write drivers to intermediate connectivity to a large variety of providers.
Razor Pay Razor Pay is a large payment processor from India.
Enable API Integration¶
- Click the
Add
button. -
Select the desired service from the list.
-
Complete the available fields (see individual API integrations below for details for each provider).
- Click the
Save
button.
API Service details
Each service requires different details. These can be obtained using your account with the specific provider(s).
Compare PayPal options¶
Mass Payment is a bulk payment method that sends funds in an uploaded file to PayPal, allowing the sender to pay less than the standard PayPal fees using their bulk order discounts. Since this payment does not trigger anything our VoIP system, we link into PayPal's IPN to accommodate notifications and balance sheet updates.
Mass Pay vs Express Checkout
Use this comparison chart listing the differences between Mass Pay and Express Checkout with PayPal to help you decide which to use:
Mass Pay | Express Checkout |
---|---|
A CSV is uploaded to PayPal's website. | Made through customer portal. |
Slightly lower transaction fees. | Standard PayPal fees (about 3.4% + $0.30). |
Fees are paid by the sender. | Fees are paid by the recipient. |
Sender pays a 2% transaction fee, capped at $1 per payment. | Recipient pays by per-transaction deductions. |
Uses PayPal IPN. | Uses PayPal API Signature. |
PayPal Express Checkout Integration¶
Enter the PayPal credentials into your account.
- Select
Add
then PayPal. - Mode: Use
Test
for testing connections orLive
for an active account. - To find your Username, Password, and Signature:
- Access your PayPal account, navigate to Settings Account Settings Account Access.
- Click the
Update
button for API Access. - Select Manage API Credentials under NVP/SOAP API integration (Classic) section.
- Select Request API signature, then
Agree and Submit
.
-
Copy the API Username, API Password, and Signature credentials from this page into the open PayPal form in ConnexCS.
-
Currency: Select one or more currencies that you will accept.
- Deduct Payment Fees: Set whether you will deduct the fees or not.
- Click
Save
.
PayPal IPN Integration¶
PayPal's Instant Payment Notification (IPN) is a service that provides notifications for PayPal transactions. IPN messages can be used to automate bulk payment processes, where consumers still send PayPal payments as normal. Payments made using this integration will automatically top-up the customer account in ConnexCS. For this to work, settings need to be configured on the ConnexCS control panel as well as PayPal.
Configure PayPal IPN¶
Below are the steps to configure IPN:
Step 1: Configure ConnexCS
- Select
Add
then PayPal IPN. - Update the following:
- IPN URL: This should never be modified; you will need it later to complete the integration.
- Payment Type: Select "Mass Pay" (described above) or "Send Money" (fees may apply).
- Verify Transaction: If selected, ConnexCS will check with PayPal to make sure the transaction is correct.
- Currency: Select one or more currencies that you will accept.
- Deduct Payment Fees: Set whether you will deduct the fees or not.
- Click
Save
. - To find the IPN URL (needed later in configuration), open the
paypal_ipn
now listed in API.
Step 2: Identify your IPN listener to PayPal
After you have configured ConnexCS, add it to your PayPal account (taken from PayPal support here).
- Login to a PayPal Business Account (must be a Business account, not a regular PayPal account).
- Navigate to Settings > Account Settings > Notifications.
- Select Update next to Instant payment notifications.
- Click Choose IPN Settings.
- Enter the IPN URL under Notification URL and select Receive IPN Messages (Enabled) click Save.
- Fill in the settings, and then copy the API URL.
Configure Customer with PayPal Email address¶
The following are instructions on how to add a PayPal Email address to a ConnexCS customer account:
- Navigate to Management Customer [Customer name].
- Click under Contacts.
- Enter the customer's Name and PayPal email address and click
Save
. - From the customer's main page, select Edit Config.
- Enter the customer PayPal email ID and click
Save
.
View PayPal IPN Payment Log¶
These payments can be viewed under Setup Information Payment Log.
Stripe Integration¶
Configure the Stripe API Keys in ConnexCS:
- Select
Add
then Stripe. - Mode: Use
Test
for testing connections orLive
for an active account. - Public Key (Publishable) and Private Key (Secret): Access the Stripe Dashboard(login if necessary) to access your keys (from Stripe Support;
Test
keys are also found at that link). - Currencies: Select one or more currencies that you will accept.
Duo Security Integration¶
Configure Duo Security settings in ConnexCS:
- Select
Add
then Stripe. - Integration Key, Secret, and Host: Access the Duo Admin Panel, locate
Auth API
, clickProtect
(from Duo Auth support). Find the Integration Key, Secret Key, and API Hostname to complete setup in ConnexCS.
Moneris Integration¶
Link Moneris to ConnexCS:
- Select
Add
then Moneris. - Store ID: This can be found in the MRC Welcome emails (contact Moneris for assistance finding this).
Scriptforge Integration¶
- Select
Add
then Scriptforge. - Company: Select the customer to integrate.
- Script Forge: Select the predefined script (details found under Developer Scriptforge.
Razor Pay Integration¶
Enter Razorpay settings into ConnexCS:
- Select
Add
then Razorpay. - Mode: Use
Test
for testing connections orLive
for an active account. - Key ID and Key Secret: Access Razorpay Dashboard, go to Settings and Generate Test Key (from Razorpay support)
- Currency: Select one or more currencies that you will accept.
- Deduct Payment Fees: Set whether you will deduct the fees or not.
Xero Integration¶
Coming soon