PayPal Here SDK


Get started with the SDK

  1. Set up your development environment
  2. Get the SDK
  3. SDK best practices

Set up your development environment

Before you install the SDK:

  • Download and configure the sample apps.
  • Before you can integrate PayPal Here SDK, you must set up your development environment. After you get a token that lets you access protected REST API resources, you create sandbox accounts to test your web and mobile apps. For details, see Get started.

    Then, return to this page to integrate PayPal Here SDK.

  • Read the Merchant Onboarding Guide to understand how accounts can sign up for PayPal Here and grant permissions to your app.

Get the SDK

To get the SDK:

  1. Visit the GitHub repository to get the software for either:

  2. Review the SDK's Readme file in the GitHub repository, and try building the SDK.
  3. Review the documentation specific to your integration:

Best practices

  • Title the REST Application that you created on appropriately with the business name so that merchants have a clear understanding of to whom they are providing permissions.
  • Do not store the client ID and client secret on the mobile device storage. These should be stored securely on your server or back-end server for security reasons.
  • Ensure the option to connect a merchant's PayPal account for PayPal Here processing is clear and concise. Once connected, show the email address of the connected account so the merchant is aware of which account they are using at all times.
  • Provide an option for the merchant to disconnect their account from processing. When a merchant chooses this option, remove all refresh and access tokens for that merchant from your system.
  • Use official images supplied by PayPal for any PayPal Here imagery.
  • Initialize the SDK and merchant immediately after the merchant logs into your app to allow for the app to be ready to transact on the checkout page right away.
  • Implement the appropriate listeners for the reader software update so that mandatory updates are handled accordingly.
  • Utilize your own invoice number as part of the invoice object. This parameter is used for duplicate transaction prevention in the event you need to retry a payment attempt.
  • For successful transactions, keep track of the PayPal invoice ID along with the transaction ID. These values can be used later on for refunds, get details calls, etc.
  • For error scenarios, keep track of the correlation ID, date/time of the error, and the error message itself. The correlation ID greatly decreases resolution time if it is able to be provided to PayPal support teams at all times.

When your integration is complete, check the going live page to ensure that you have everything ready for activation. Once that is working, you can implement other customizations that are available with the SDK into your integration.