First I'd like to set the context by describing the PayPal Accounts Modeling and how they operate in the PayPal Commerce Platform.
You'll typically have 3 accounts in this model:
- Partner Account (API Caller)
- Merchant Account (
payee) - Consumer Account (
payer)
This is the "standard use-case" and all of the documents in this repo have an assumption that "you" are the Partner and acting as the facilitator or "API Caller".
As a Partner, you must be setup with an account with the appropriate configuration to be able to facilitate API calls on behalf of a Merchant Account. The information on the developer.paypal.com page for Partner Onboarding will inform you how to apply for a Partner Account.
Currently (as of today, 12/18/2019), PayPal must configure both of your accounts (Sandbox & Production) in order for you to use the PayPal Commerce Platform solution(s). Therefore, I have included credentials in my samples that have Partner Accounts that have been configured for the applicable use-case. You may use those API Credentials to verify the API's and test with the Postman collections that are provided in the use-case documentation.
Within this repository, I provide some use-case specific documents to help with the integration of PayPal Commerce Platform. The naming of the directories reflect the PayPal Commerce Platform products that are used, I name them this way to help me with updating and testing the various cases.
The use-cases listed here suit the model where the Partner has a Hosted Platform, meaning that the Partner hosts the application driving the platform and Merchants and Consumers access this Platform to interact and make transactions. This may be a Marketplace, Hosted Shopping Cart, or other hosted platform.
eCommerce - Partner NOT charging a per-transaction fee
In this model, the Partner is simply a facilitator of the transactions and will not collect a "platform fee" or "partner fee" per transaction.
- Merchant Onboarding Used: Connected Path Upfront Onboarding
- Checkout Used: PayPal Smart Payment Buttons and Orders v2 API
- Refunds Used: PayPal Refund API with Payments v2 API
My Full Step-By-Step Readme Documentation: Connected_Path_Orders_Refund
eCommerce - Partner IS charging a per-transaction fee
In this model, the Partner is simply a facilitator of the transactions and WILL collect a "platform fee" or "partner fee" per transaction. Besides the collection of the Partner Fee, this model is the same as the above example.
- Merchant Onboarding Used: Connected Path Upfront Onboarding
- Checkout Used: PayPal Smart Payment Buttons and Orders v2 API
- Refunds Used: PayPal Refund API with Payments v2 API
My Full Step-By-Step Readme Documentation: Connected_Path_Orders_Fee_Refund
eCommerce - Billing Agreements between the Merchant and Consumer
In this model, the Partner manages the creation of a Billing Agreement between the Consumer (payer) and the Merchant (payee). This use-case is applicable in most Hosted Platforms when the Consumer (payer) is not necessarily aware of the Platform that hosts the Merchants (payee's) site/experience. A primary callout here is that when the Consumer logs into PayPal, they will see information about their Agreement and they will see the Merchant's name in the Terms & Conditions of the Billing Agreement.
I give additional specifics of the Merchant and Consumer Billing Agreements in the Billing-Agreements README.
- Merchant Onboarding Used: Connected Path Upfront Onboarding
- Checkout Used: PayPal Smart Payment Buttons, PayPal Billing Agreements, and Orders v2 API
- Refunds Used: PayPal Refund API with Payments v2 API
My Full Step-By-Step Readme Documentation: Connected_Path_Merchant_BA_Orders_Refund
eCommerce - Billing Agreements between the Partner and Consumer
In this model, the Partner allows the Consumer (payer) to enter into a Billing Agreement with the Partner or Platform. This use-case is applicable in most Marketplace type models where the Consumer (payer) is aware of the Platform and may be adding PayPal as a Funding Source on that Platform. A primary callout here is that when the Consumer logs into PayPal, they will see information about their Agreement and they will see the Partner's name in the Terms & Conditions of the Billing Agreement.
I give additional specifics of the Partner and Consumer Billing Agreements in the Billing-Agreements README.
- Merchant Onboarding Used: Connected Path Upfront Onboarding
- Checkout Used: PayPal Smart Payment Buttons, PayPal Billing Agreements, and Orders v2 API
- Refunds Used: PayPal Refund API with Payments v2 API
My Full Step-By-Step Readme Documentation: Connected_Path_Partner_BA_Orders_Refund