Created: February 27, 2023
Last Updated: May 30, 2024
OVERVIEW
PayPal Payments has 2 implementations, a redirect to their payment page or buttons that use popup modals to show the payment form. This integration is compatible with the redirect method currently.
For more information on PayPal Integrations click here
Redirect Method
Send a normal new order request with card type = paypal
and include alt_pay_return_url
(for paypal to redirect back to your website). Make sure to not use AJAX and do not send any headers with your new order request. All values are obtained from the front end communications with PayPal. Refer to PayPal's Integration documentation for more information on the front end implementation.
Sticky API documentation can be located here https://developer-prod.sticky.io/#729244f5-48a0-462f-be16-8ff2e8292bfd
IMPORTANT NOTES
PayPal V2 uses the PayPal Vault method to tokenize payments.
Clients MUST turn on PayPal Vaulting on their PayPal Mids
Currently PayPal does not work with the sticky NOCOF API
Enable Vaulting
Log into the business dashboard and click the developer link on top
Then click this tab
Click on the Application for their API Key
Click the Vault checkbox (once checked this cannot be unchecked)
Save the changes
Add PayPal Payment Provider for PayPal V2
To configure PayPal V2 (Alternative Payment) into your sticky.io CRM, you will go to Payments>Gateways, under ACTIONS select Add New Provider Profile. Select the type = Payment/Gateway and select PayPal V2 (Alternative Payment) from the drop down. Fill out the gateway parameters which are outlined below and click “Save”.
These parameters are briefly described here for your reference:
Alias: name that you will assign to the gateway. This is for internal purposes only; it helps you identify a specific gateway account among several of them in your CRM.
Client ID: PayPal will provide you with the Client ID.
Client Secret: PayPal will provide you with the Client Secret.
Send Tracking Info: Yes - this response will have your orders tracking information sent to PayPal. Selecting NO will not send tracking information to PayPal.
Test Mode: Set to YES if you would like to use this gateway in test mode.
***NOTE*** if you use Wallet Info AND there is no Customer data for email, name and address in the new_order_API call you make to us for an order AND PayPal does not return any wallet data for the order THEN sticky will populate the missing fields with dummy data.
Use Wallet Info: This configuration will allow existing customer and order information to be updated and/or overwritten to wallet information returned from the provider. sticky recommends always sending in the customers email, name, phone and address with the New_Order_API call even if the customer is using PayPal - this is the only way to prevent dummy data 100% of the time.
***NOTE*** if you use either delayed settlement feature below it is IMPERATIVE that you do not change the gateway if your Order status is pending. These transactions will ONLY settle on the MID the were authorized on.
Enable Delayed Capture: Set to YES if you want to capture an authorization up to seven days from the day of the auth. Also an order will remain as pending in the system until the authorization is captured upon the count of days defined. Set to No if you want the standard authorization and capture process for your orders
Capture on Shipment: Set to YES if you want to capture an authorization once an order is marked a shipped in the CRM. Also, an order will remain as pending in the system until the authorization is captured upon shipment. Set to No if you want the standard authorization and capture process for your orders
There are 2 Required Fields on the Merchant Account Details tab.
· *Descriptor - This will be the MID Descriptor
· *Customer Service Number - The customer service number assigned to the MID
There is 1 Required Field on the Limits and Fees tab
· *Global Monthly Cap - This will be the sales amount allowed monthly on this MID
To maximize the efficiency of sticky.io Reporting Analytics we suggest you take a moment and fill out the rest of the fields. These will all be used in sticky.io’s profitability reports.
Once your gateway profile has been created, then you will go through your campaigns and assign the gateway to the corresponding campaign(s).