Set up

You can use the steps in this section to ensure that your accounts and environment are set up to accept Pix payments.

1. Sign up for a PayPal developer account. On successful signup, PayPal automatically creates your sandbox environment. The sandbox environment is a test environment that helps you mimic real-world transactions. By default, the environment includes a business and personal account. You can create additional personal and business sandbox accounts as needed.
   

2. Set up the sandbox environment:

   1. Go to your PayPal developer account sandbox and toggle to Sandbox.
   2. Go to Apps & Credentials and select Create App.
   3. Enter your app name, set the Type to Merchant, choose the sandbox business account, and select Create App. The app details page is displayed.
   4. Configure a webhook listener for the app and subscribe to events:
      • In the app details page, go to Sandbox Webhooks.
      • Select Add Webhook.
      • Enter a Webhook URL (the server endpoint where notifications from PayPal are sent), select the events the app wants to subscribe to, and select Save.

      The webhook listener is successfully configured, and a Webhook ID is displayed. You can store the ID and use it in your app code to verify the source sending messages to your listener. For more information on webhooks, see Use webhooks.

3. Retrieve sandbox app credentials: To integrate and test Pay with Pix, you require the following sandbox credentials for your app:
   1. Client ID: App identifier that helps with account authentication.
   2. Client Secret: App credential that helps with app authorization.
4. To retrieve the sandbox credentials:
   1. Go to your PayPal developer account and switch to Sandbox.
   2. Go to Apps & Credentials > API Credentials > REST API apps.
   3. Copy the Client ID and Client Secret listed next to your app name and save them.
5. Retrieve sandbox account credentials: To test your Pay with Pix integration end-to-end, run your app, simulate a checkout flow, log in to your personal PayPal sandbox account to approve the Pix payment, and confirm that the money is received in your business PayPal sandbox account in BRL. You need sandbox login credentials for both accounts. For information on how to access or reset these credentials, see Get sandbox account credentials.
6. Set up the development environment.

1. Log in to the PayPal Developer Dashboard and switch to the Live environment.
2. Go to Apps & Credentials and create a new app or select an existing app.
3. In the app’s Features tab, ensure Accept payments is enabled.
   • Configure a webhook listener for the app and subscribe to events:
     • On the app details page, go to Live Webhooks.
     • Select Add Webhook.
     • Enter your Webhook URL (the server endpoint where notifications from PayPal are sent), select the events the app wants to subscribe to, and select Save.
     • [Recommended] Subscribe to the following events:
       • CHECKOUT.ORDER.APPROVED: Approval of checkout order
       • CHECKOUT.ORDER.COMPLETED: Successful Pix payment
       • CHECKOUT.PAYMENT-APPROVAL.REVERSED: Failed or expired capture
     • Click Save. A Webhook ID will be generated.
       The webhook listener is successfully configured, and a Webhook ID is displayed. You can store the ID and use it in your app code to verify the source sending messages to your listener. For more information on webhooks, see Use webhooks.
4. Copy your Client ID and Secret for the live app.
5. Enable Pay with Pix for the production account.

You can enable Pay with Pix using one of the following methods:

• Enable Pay with Pix from your PayPal dashboard
• Request approval to enable Pay with Pix

Enable Pay with Pix from your PayPal dashboard

If you have an eligible PayPal business account, you can enable Pay with Pix directly from your dashboard:

1. Log in to your PayPal business account.
2. Go to Account Settings > Products & Services > Payment Methods.
3. Click Setup Pix. On the Pix key setup page, your Pix keys (tax ID, email, or phone number) are pre-populated from your profile. Review the details and select Save.

Request approval to enable Pay with Pix

If you don't see Pay with Pix in your dashboard, request approval by visiting the links below:

• Sandbox: https://www.sandbox.paypal.com/unifiedonboarding/entry?country.x=BR&products=PIX
• Live: https://www.paypal.com/unifiedonboarding/entry?country.x=BR&products=PIX

Pix payments are activated after PayPal verifies eligibility and completes a compliance review. Ensure your account is configured to accept payments in BRL, as all Pix payments are settled in BRL.