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 Pagos:

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 Pagos Dashboard.

2

Under Rights Granted for this new role, enable only the following permissions:

  • Transactions
    • Download Transactions with Masked Payment Data
  • Reporting
    • Create, Run, and Download Reports
    • View Dashboard Graphs
  • Recurring Billing
    • Download Subscription Records
    • View Modifications
    • View Subscription Plans
    • View Subscriptions
    • Search Subscriptions
  • Dispute Management
    • View, manage and contest disputes
  • Webhooks
    • Manage Webhooks (Add/Edit/Delete)
  • Statements
    • View Statements
  • Read-Only Access
    • View Merchant Accounts
    • View Payment Methods
    • View Transactions
    • View Verifications
    • Download Files
  • Search
    • Search Transactions
    • 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 Pagos.

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:

​
Step 3 - Add a New Data Connection to Your Pagos Account

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

1

2

Click your profile icon at the bottom of the main navigation.

3

Under Data Connections, click Connections.

4

Click Add Data Connection.

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:

  • Data Connection Name - This value is used for display and identification on charts, and can be whatever you prefer
  • Merchant ID
  • Public Key
  • Private Key
7

Click Add Data Connection icon.

​
Step 4 - Create a Webhook

Sensitive Data Warning:

Never include sensitive customer data in the metadata fields passed to Pagos via webhook.

After you enter your Braintree details in the Data Connections page and click Add Data Connection, you’ll be prompted to create a webhook:

1

Click the copy icon beside Webhook Destination, then click Complete Webhook Set-Up.

2

Log into your Braintree limited access user account and follow the process outlined in Braintree’s documentation to create a webhook.

3

On the New Webhook screen, paste the destination URL you copied from your Pagos account into the Destination URL field.

4

Under Notifications on that same screen, 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:

  • Statements
    • View Statements
  • Read-Only Access
    • Download Files
  • Reporting
    • 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 Pagos.

6

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