{"_id":"5703c7f2903e330e002d8724","version":{"_id":"5703c7f2903e330e002d8703","__v":4,"hasDoc":true,"hasReference":true,"project":"56682f6c1fb5701900f893a0","createdAt":"2016-04-05T14:13:06.422Z","releaseDate":"2016-04-05T14:13:06.422Z","categories":["5703c7f2903e330e002d8704","5703c7f2903e330e002d8705","5703c7f2903e330e002d8706","5703c7f2903e330e002d8707","5703c7f2903e330e002d8708","5703c7f2903e330e002d8709","5703c7f2903e330e002d870a","5703c7f2903e330e002d870b","5703c7f2903e330e002d870c","573d96148ca48f320093ed5b","573dd2e38cf1492400bba6e0","57a9cc1f5b1ace0e00de743e"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"2.0.0","version":"2"},"category":{"_id":"5703c7f2903e330e002d870b","__v":0,"version":"5703c7f2903e330e002d8703","project":"56682f6c1fb5701900f893a0","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-03-01T16:49:09.087Z","from_sync":false,"order":8,"slug":"brand-configuration","title":"Brand Configuration"},"__v":3,"user":"56a221e00aefae0d00b7fdf1","parentDoc":null,"project":"56682f6c1fb5701900f893a0","updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-03-02T10:30:13.628Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":4,"body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Introduction\"\n}\n[/block]\nThere are two options available to configure PayPal credentials.\n\nThe quickest and easiest solution would be to use our white-label credentials, which have already been created and verified. This requires nothing from you, and will simply be inputted by us into your brand configuration. By using our credentials, it should be noted that when the site owner connects to PayPal for the first time, the company name they will be presented with will be our white nabel name of ‘Website Builder Software’.\n\nAlternatively, you can choose to set up your own PayPal credentials and provide us with them to be entered into your brand configuration. Please note that setting up these credentials will be your responsibility, and we are unable to do this on your behalf.  If you choose to create your credentials please follow the below instructions.\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Account types\"\n}\n[/block]\nThere are two types of account for PayPal when setting up eCommerce; Environmental and Store Owner. \n\n**Environmental**\n  * Each environment requires a top level account to provide API/client details which provides access to the payment provider’s API. \n  * This account is also used to configure partner branding. \n  * No monetary transactions are made through this account. \n  * This guide details how to create the credentials for this type of account to enable store owners to set up their PayPal account. \n\n**Store owner**\n  * Each store requires a PayPal account to be linked to provide access to the payment gateway for transactions. \n  * The store owner is required to have at least one payment provider setup before they can open their store for trading.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Stages\"\n}\n[/block]\nThere are three stages involved in creating your PayPal credentials:\n\n1. Creating your PayPal business account and ensuring this is verified\n2. Obtaining the Signature API credentials \n3. And finally, completing an application to get the APP ID \n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Steps\"\n}\n[/block]\n**Create PayPal Business Account**\n\n1. Either use an existing PayPal account and upgrade to a business account or create a new account to be used as the business account. \n\n2. If creating a new account, sign up here and choose business account: https://www.paypal.com/uk/webapps/mpp/account-selection.\n\n3. If using an existing PayPal account, log in and go to **Profile**, and select **Upgrade to Business** account.\n\n4. Once you have set up your business account, you must ensure that it becomes a verified business account before starting the following steps.\n\nThe verification process is important because PayPal need the account verified before they grant API access. \n\nPlease note that bank account details are required as part of the verification process to allow the account holder access to the API - no money transactions are made with this account. PayPal use these details to verify that the account holder is genuine. \n\n**Signature API Credentials**\n\n5 .Once your PayPal Business account is verified you will have access to three of the four credentials; this set of credentials is called the Signature API credentials:\n\n  * API Username\n  * API Password\n  * Signature\n\nNote: PayPal guidance on creating Signature API credentials can be found here: https://developer.paypal.com/docs/classic/api/apiCredentials/ \n\n4. To find these three credentials follow the below steps:\n\n5. Go to **Profile **in the top right hand corner and select **My selling preferences**.\n\n6. Under **Selling Online** select **Update **on the **API access** row.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/T4MdOfmASPahuTavB09i_ScreenHunter_2306%20Mar.%2002%2017.13.jpg\",\n        \"ScreenHunter_2306 Mar. 02 17.13.jpg\",\n        \"634\",\n        \"223\",\n        \"#6a849c\",\n        \"\"\n      ],\n      \"caption\": \"Update API access\"\n    }\n  ]\n}\n[/block]\n7. Select **Option 2: Request API Credentials**.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/D6CcHfs1T8uGG5qGYHWy_ScreenHunter_2307%20Mar.%2002%2017.13.jpg\",\n        \"ScreenHunter_2307 Mar. 02 17.13.jpg\",\n        \"620\",\n        \"329\",\n        \"#a68a6e\",\n        \"\"\n      ],\n      \"caption\": \"Click Request API crdentials\"\n    }\n  ]\n}\n[/block]\n8. Ensure **Request API Signature** is selected and click **Agree and Submit**.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/YftZ0J1rTreHCw8Sw2d9_ScreenHunter_2308%20Mar.%2002%2017.13.jpg\",\n        \"ScreenHunter_2308 Mar. 02 17.13.jpg\",\n        \"639\",\n        \"344\",\n        \"#c79753\",\n        \"\"\n      ],\n      \"caption\": \"Request API Signature\"\n    }\n  ]\n}\n[/block]\n9. Click **Show **against the **API Username, API Password and Signature** and enter these into the relevant fields in your BaseKit brand form. \n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/L1ZFY8HQL2iFgY5VomiQ_ScreenHunter_2309%20Mar.%2002%2017.13.jpg\",\n        \"ScreenHunter_2309 Mar. 02 17.13.jpg\",\n        \"635\",\n        \"287\",\n        \"#c1915c\",\n        \"\"\n      ],\n      \"caption\": \"Show credentials\"\n    }\n  ]\n}\n[/block]\n10. The final credential needed is the App ID.\n\n11. Go to https://developer.paypal.com/ \n\n12. Select **Dashboard** in the top right hand corner. \n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/7K2DtJkVRQ2mcjMGvoHy_ScreenHunter_2575%20Jun.%2010%2016.03.jpg\",\n        \"ScreenHunter_2575 Jun. 10 16.03.jpg\",\n        \"763\",\n        \"297\",\n        \"#b93062\",\n        \"\"\n      ],\n      \"caption\": \"Select Dashboard\"\n    }\n  ]\n}\n[/block]\n13. Click **Create and manage NVP/SOAP API apps**.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/2pT72pWZRdmBNk0ZO4Uc_ScreenHunter_2576%20Jun.%2010%2016.03.jpg\",\n        \"ScreenHunter_2576 Jun. 10 16.03.jpg\",\n        \"764\",\n        \"503\",\n        \"#5eacd2\",\n        \"\"\n      ],\n      \"caption\": \"Select Create and Manage NVP/SOAP API Apps\"\n    }\n  ]\n}\n[/block]\n14. Login (again) with your Paypal credentials.\n\n15. Select **New Application**.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/HA7Coh3JQWGrjFinHNa7_ScreenHunter_2312%20Mar.%2002%2017.13.jpg\",\n        \"ScreenHunter_2312 Mar. 02 17.13.jpg\",\n        \"643\",\n        \"115\",\n        \"#090909\",\n        \"\"\n      ],\n      \"caption\": \"Click New Application\"\n    }\n  ]\n}\n[/block]\n16. Fill in the new application as per the details below.\n\n**DO NOT DEVIATE FROM THE SPECIFIC TEXT AND ITEMS THAT REQUIRE CHECKING:** \n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Entry\",\n    \"0-0\": \"Title\",\n    \"0-1\": \"<Your website builder company name>\",\n    \"1-0\": \"Platform\",\n    \"1-1\": \"Web\",\n    \"2-1\": \"Lets users build and publish a website with an integrated eCommerce store. This allows a site owner to offer products and services for sale through their website, and take payments for these online via PayPal and other payment providers.\",\n    \"2-0\": \"Please describe what your application does in detail and how each of the API features will be used by your application\"\n  },\n  \"cols\": 2,\n  \"rows\": 3\n}\n[/block]\nIndustry and Use Cases\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Title\",\n    \"h-1\": \"Entry\",\n    \"0-0\": \"Select from the Related Industry list below and supply required information if needed.\",\n    \"0-1\": \"None of the Below\",\n    \"1-0\": \"Select from the Use Case list below.\",\n    \"1-1\": \"Storefront\"\n  },\n  \"cols\": 2,\n  \"rows\": 2\n}\n[/block]\nServices used by app - Adaptive payments\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Entry\",\n    \"0-0\": \"Basic payments\",\n    \"0-1\": \"Checkout, Send money\\n\\nParallel Payments\\n\\nGet payment Details\",\n    \"2-0\": \"The payments to secondary receivers are:\\n\\nWho pays the fee?\\n\\nWho is the primary receiver\\n\\nWho is (are) the secondary receiver:\",\n    \"2-1\": \"Instant\\n\\nPrimary receiver\\n\\nSite (store) Owner\\n\\n<Your website builder company name>\",\n    \"3-0\": \"Expected monthly payment volume and average transaction amount in US\",\n    \"3-1\": \"1000\\n10\",\n    \"5-0\": \"Do you have an Acceptable Use Policy?\",\n    \"5-1\": \"Yes\",\n    \"6-0\": \"If yes, where can we find it?\",\n    \"6-1\": \"We manually inspect store websites when they go live to ensure they are not breaking any paypal merchant rules\",\n    \"4-1\": \"The Site Owner\",\n    \"4-0\": \"Who is responsible for chargebacks or refunds?\",\n    \"1-0\": \"Chained payments\",\n    \"1-1\": \"See below\"\n  },\n  \"cols\": 2,\n  \"rows\": 7\n}\n[/block]\n3rd party Permissions\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Entry\",\n    \"0-0\": \"Which APIs will your end-users need to grant permissions for?\",\n    \"0-1\": \"Authorise and capture your paypal transactions\\nObtain transaction specific information\\n\\nProcess a payment based on previous transaction\\n\\nUse express checkout to process mobile payments\\n\\nUse express checkout to process payments\"\n  },\n  \"cols\": 2,\n  \"rows\": 1\n}\n[/block]\nTesting information\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Entry\",\n    \"0-0\": \"Step-by-step Payment Flows Instructions\",\n    \"0-1\": \"Each store website on the platform will present products that can be added to a shopping basket. The payment process can be seen by following the checkout link and choosing paypal as the payment method\",\n    \"1-0\": \"Supply Test account Name and password\",\n    \"1-1\": \"Please contact us for website credentials\"\n  },\n  \"cols\": 2,\n  \"rows\": 2\n}\n[/block]\nBusiness Information\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"Would you like your application considered for listing in our App Gallery?\",\n    \"0-1\": \"No\",\n    \"h-0\": \"Field\",\n    \"h-1\": \"Entry\"\n  },\n  \"cols\": 2,\n  \"rows\": 1\n}\n[/block]\n17. Once this is completed, you will get a notification on the screen from Paypal. It should state that it has been **Approved Conditionally** along with your Sandbox ID and Live App ID. \n\n18. Please enter the **Live App ID ** into the PayPal App ID field in your Basekit brand form. \n\nIf your Application is not approved, it will state so. This will mean that incorrect data has been \nentered somewhere. You will then need to go back through the process.\n\nIf you continue to get rejected, or you get any emails concerning the status of the APP ID, you\nshould contact your Project Manager.","excerpt":"","slug":"paypal-credentials","type":"basic","title":"PayPal Credentials"}

PayPal Credentials


[block:api-header] { "type": "basic", "title": "Introduction" } [/block] There are two options available to configure PayPal credentials. The quickest and easiest solution would be to use our white-label credentials, which have already been created and verified. This requires nothing from you, and will simply be inputted by us into your brand configuration. By using our credentials, it should be noted that when the site owner connects to PayPal for the first time, the company name they will be presented with will be our white nabel name of ‘Website Builder Software’. Alternatively, you can choose to set up your own PayPal credentials and provide us with them to be entered into your brand configuration. Please note that setting up these credentials will be your responsibility, and we are unable to do this on your behalf. If you choose to create your credentials please follow the below instructions. [block:api-header] { "type": "basic", "title": "Account types" } [/block] There are two types of account for PayPal when setting up eCommerce; Environmental and Store Owner. **Environmental** * Each environment requires a top level account to provide API/client details which provides access to the payment provider’s API. * This account is also used to configure partner branding. * No monetary transactions are made through this account. * This guide details how to create the credentials for this type of account to enable store owners to set up their PayPal account. **Store owner** * Each store requires a PayPal account to be linked to provide access to the payment gateway for transactions. * The store owner is required to have at least one payment provider setup before they can open their store for trading. [block:api-header] { "type": "basic", "title": "Stages" } [/block] There are three stages involved in creating your PayPal credentials: 1. Creating your PayPal business account and ensuring this is verified 2. Obtaining the Signature API credentials 3. And finally, completing an application to get the APP ID [block:api-header] { "type": "basic", "title": "Steps" } [/block] **Create PayPal Business Account** 1. Either use an existing PayPal account and upgrade to a business account or create a new account to be used as the business account. 2. If creating a new account, sign up here and choose business account: https://www.paypal.com/uk/webapps/mpp/account-selection. 3. If using an existing PayPal account, log in and go to **Profile**, and select **Upgrade to Business** account. 4. Once you have set up your business account, you must ensure that it becomes a verified business account before starting the following steps. The verification process is important because PayPal need the account verified before they grant API access. Please note that bank account details are required as part of the verification process to allow the account holder access to the API - no money transactions are made with this account. PayPal use these details to verify that the account holder is genuine. **Signature API Credentials** 5 .Once your PayPal Business account is verified you will have access to three of the four credentials; this set of credentials is called the Signature API credentials: * API Username * API Password * Signature Note: PayPal guidance on creating Signature API credentials can be found here: https://developer.paypal.com/docs/classic/api/apiCredentials/ 4. To find these three credentials follow the below steps: 5. Go to **Profile **in the top right hand corner and select **My selling preferences**. 6. Under **Selling Online** select **Update **on the **API access** row. [block:image] { "images": [ { "image": [ "https://files.readme.io/T4MdOfmASPahuTavB09i_ScreenHunter_2306%20Mar.%2002%2017.13.jpg", "ScreenHunter_2306 Mar. 02 17.13.jpg", "634", "223", "#6a849c", "" ], "caption": "Update API access" } ] } [/block] 7. Select **Option 2: Request API Credentials**. [block:image] { "images": [ { "image": [ "https://files.readme.io/D6CcHfs1T8uGG5qGYHWy_ScreenHunter_2307%20Mar.%2002%2017.13.jpg", "ScreenHunter_2307 Mar. 02 17.13.jpg", "620", "329", "#a68a6e", "" ], "caption": "Click Request API crdentials" } ] } [/block] 8. Ensure **Request API Signature** is selected and click **Agree and Submit**. [block:image] { "images": [ { "image": [ "https://files.readme.io/YftZ0J1rTreHCw8Sw2d9_ScreenHunter_2308%20Mar.%2002%2017.13.jpg", "ScreenHunter_2308 Mar. 02 17.13.jpg", "639", "344", "#c79753", "" ], "caption": "Request API Signature" } ] } [/block] 9. Click **Show **against the **API Username, API Password and Signature** and enter these into the relevant fields in your BaseKit brand form. [block:image] { "images": [ { "image": [ "https://files.readme.io/L1ZFY8HQL2iFgY5VomiQ_ScreenHunter_2309%20Mar.%2002%2017.13.jpg", "ScreenHunter_2309 Mar. 02 17.13.jpg", "635", "287", "#c1915c", "" ], "caption": "Show credentials" } ] } [/block] 10. The final credential needed is the App ID. 11. Go to https://developer.paypal.com/ 12. Select **Dashboard** in the top right hand corner. [block:image] { "images": [ { "image": [ "https://files.readme.io/7K2DtJkVRQ2mcjMGvoHy_ScreenHunter_2575%20Jun.%2010%2016.03.jpg", "ScreenHunter_2575 Jun. 10 16.03.jpg", "763", "297", "#b93062", "" ], "caption": "Select Dashboard" } ] } [/block] 13. Click **Create and manage NVP/SOAP API apps**. [block:image] { "images": [ { "image": [ "https://files.readme.io/2pT72pWZRdmBNk0ZO4Uc_ScreenHunter_2576%20Jun.%2010%2016.03.jpg", "ScreenHunter_2576 Jun. 10 16.03.jpg", "764", "503", "#5eacd2", "" ], "caption": "Select Create and Manage NVP/SOAP API Apps" } ] } [/block] 14. Login (again) with your Paypal credentials. 15. Select **New Application**. [block:image] { "images": [ { "image": [ "https://files.readme.io/HA7Coh3JQWGrjFinHNa7_ScreenHunter_2312%20Mar.%2002%2017.13.jpg", "ScreenHunter_2312 Mar. 02 17.13.jpg", "643", "115", "#090909", "" ], "caption": "Click New Application" } ] } [/block] 16. Fill in the new application as per the details below. **DO NOT DEVIATE FROM THE SPECIFIC TEXT AND ITEMS THAT REQUIRE CHECKING:** [block:parameters] { "data": { "h-0": "Field", "h-1": "Entry", "0-0": "Title", "0-1": "<Your website builder company name>", "1-0": "Platform", "1-1": "Web", "2-1": "Lets users build and publish a website with an integrated eCommerce store. This allows a site owner to offer products and services for sale through their website, and take payments for these online via PayPal and other payment providers.", "2-0": "Please describe what your application does in detail and how each of the API features will be used by your application" }, "cols": 2, "rows": 3 } [/block] Industry and Use Cases [block:parameters] { "data": { "h-0": "Title", "h-1": "Entry", "0-0": "Select from the Related Industry list below and supply required information if needed.", "0-1": "None of the Below", "1-0": "Select from the Use Case list below.", "1-1": "Storefront" }, "cols": 2, "rows": 2 } [/block] Services used by app - Adaptive payments [block:parameters] { "data": { "h-0": "Field", "h-1": "Entry", "0-0": "Basic payments", "0-1": "Checkout, Send money\n\nParallel Payments\n\nGet payment Details", "2-0": "The payments to secondary receivers are:\n\nWho pays the fee?\n\nWho is the primary receiver\n\nWho is (are) the secondary receiver:", "2-1": "Instant\n\nPrimary receiver\n\nSite (store) Owner\n\n<Your website builder company name>", "3-0": "Expected monthly payment volume and average transaction amount in US", "3-1": "1000\n10", "5-0": "Do you have an Acceptable Use Policy?", "5-1": "Yes", "6-0": "If yes, where can we find it?", "6-1": "We manually inspect store websites when they go live to ensure they are not breaking any paypal merchant rules", "4-1": "The Site Owner", "4-0": "Who is responsible for chargebacks or refunds?", "1-0": "Chained payments", "1-1": "See below" }, "cols": 2, "rows": 7 } [/block] 3rd party Permissions [block:parameters] { "data": { "h-0": "Field", "h-1": "Entry", "0-0": "Which APIs will your end-users need to grant permissions for?", "0-1": "Authorise and capture your paypal transactions\nObtain transaction specific information\n\nProcess a payment based on previous transaction\n\nUse express checkout to process mobile payments\n\nUse express checkout to process payments" }, "cols": 2, "rows": 1 } [/block] Testing information [block:parameters] { "data": { "h-0": "Field", "h-1": "Entry", "0-0": "Step-by-step Payment Flows Instructions", "0-1": "Each store website on the platform will present products that can be added to a shopping basket. The payment process can be seen by following the checkout link and choosing paypal as the payment method", "1-0": "Supply Test account Name and password", "1-1": "Please contact us for website credentials" }, "cols": 2, "rows": 2 } [/block] Business Information [block:parameters] { "data": { "0-0": "Would you like your application considered for listing in our App Gallery?", "0-1": "No", "h-0": "Field", "h-1": "Entry" }, "cols": 2, "rows": 1 } [/block] 17. Once this is completed, you will get a notification on the screen from Paypal. It should state that it has been **Approved Conditionally** along with your Sandbox ID and Live App ID. 18. Please enter the **Live App ID ** into the PayPal App ID field in your Basekit brand form. If your Application is not approved, it will state so. This will mean that incorrect data has been entered somewhere. You will then need to go back through the process. If you continue to get rejected, or you get any emails concerning the status of the APP ID, you should contact your Project Manager.