Connect to Braintree

This guide outlines the necessary steps to connect your Pagos and Braintree accounts. For more information on connecting Pagos to other payment processors, see our Connecting Your Payment Processors to Pagos guide.

Step 1 - Create a Limited Access Role in Your Braintree Account

For added security of your data, we recommend that you log into your Braintree admin account and create a limited access API key for use with Peacock:

  1. Log into your Braintree production environment as an admin and follow the process outlined in Braintree's documentation to create a new role. Name it something specific to its use, like Peacock Dashboard.
  2. Under Rights Granted for this new role, enable only the following permissions:
    1. Transactions
      1. Download Transactions with Masked Payment Data
    2. Reporting
      1. Create, Run, and Download Reports
      2. View Dashboard Graphs
    3. Recurring Billing
      1. Download Subscription Records
      2. View Modifications
      3. View Subscription Plans
      4. View Subscriptions
      5. Search Subscriptions
    4. Dispute Management
      1. View, manage and contest disputes
    5. Webhooks
      1. Manage Webhooks (Add/Edit/Delete)
    6. Statements
      1. View Statements
    7. Read-Only Access
      1. View Merchant Accounts
      2. View Payment Methods
      3. View Transactions
      4. View Verifications
      5. Download Files
    8. Search
      1. Search Transactions
      2. Search Verifications
  3. Click Create Role.

Step 2 - Create an API User in Your Braintree Account

After you create a limited access role, create an API user in your Braintree dashboard:

  1. Follow the process outlined in Braintree's documentation to create a new user.
  2. Under API Access, click the checkbox beside API Access.
  3. Under Roles, click the checkbox beside your new limited access role.
  4. Under Merchant Accounts click the checkbox beside all of the merchant accounts for which you want data to flow to Peacock.
  5. Click Create User.
  6. Log out of your admin account, then log back in as your read-only user account.
  7. Locate and save the following values for future use:
    1. Merchant ID
    2. Public key
    3. Private key

Step 3 - Add a New Data Source to Your Pagos Account

To pull in Braintree data to Pagos, you'll need to add a new data source in your Pagos account:

  1. Log into your Pagos account.
  2. Click your profile icon in the navigation bar, then click Manage Account.
  3. Click the Data Sources tab.
  4. To add a new data source, click + Add Data Source.
  5. In the side panel that opens, click the Provider drop-down, then select Braintree.
  6. Fill in the following fields using the saved values from Step 2:
    1. Name - This value is used for display and identification on charts, and can be whatever you prefer
    2. Merchant ID
    3. Public Key
    4. Private Key
  7. Add any desired Tags to your data source.
  8. Click the save icon.

Step 4 - Create a Webhook

After you enter your Braintree details in the Data Sources page of your Pagos account and click Add, a pop-up will prompt you to create a webhook. Click Copy beside the destination URL, then click Ok.

Next, log into your Braintree limited access user account and follow the process outlined in Braintree's documentation to create a webhook.

On the New Webhook screen:

  • Paste the destination URL you copied from your Pagos account into the Destination URL field
  • Under Notifications, click the checkbox beside each notification event option.

Step 5 (Optional) - Create a User for Sending Fee Data to Pagos

To send your Braintree fee data to Pagos, you’ll need to create another Braintree role and user specifically for this purpose:

  1. Follow the instructions under Step 1 to create a second role.
  2. Under Rights Granted for this new role, enable only the following permissions:
    1. Statements
      1. View Statements
    2. Read-Only Access
      1. Download Files
    3. Reporting
      1. Create, Run, and Download Reports
  3. Name the role something specific to its use, like Fee Data, and save it.
  4. Create a new user that you can share with Pagos.
  5. Under Roles, click the checkbox beside your Fee Data role, and under Merchant Accounts click the checkbox beside all of the merchant accounts for which you want data to flow to Peacock.

You’ll then work with your Pagos account manager to give us access to this new user.

Step 6 - Allowlist the Pagos IPs (If Necessary)

If you have network restrictions in place on your Braintree account, you’ll need to allowlist the Pagos IP addresses so we can receive your payments data without interruption. Following the instructions in Braintree’s documentation, allowlist the following IP addresses:

  • 3.224.240.39
  • 52.3.60.58
  • 54.210.17.78
  • 52.55.42.147

What’s Next