Braintree

This guide will help you to obtain your Braintree API credentials to ingest settlement and payment data from Braintree into your Payrails account.

Prerequisites

• A Braintree account and admin access.

Step-by-step instructions

We recommend that you create a limited access set of API keys for Payrails reporting.

Step 1: Log into Braintree production environment as an admin

Step 2: Create a new role

1. Follow the instructions in the Braintree documentation to create a new role.
2. Assign the following permissions to this new role under “Rights Granted“:
   1. Transactions
   2. Download Transactions with Masked Payment Data
   3. Reporting
   4. Create, Run, and Download Reports
   5. View Dashboard Graphs
   6. Read-only Access
   7. View Merchant Accounts
   8. View Payment Methods
   9. View Transactions
   10. View Verifications
   11. Download Files
   12. Statements
   13. View statements
   14. Search
   15. Search Transactions
   16. Search Verifications

Step 3: Create a new user, and generate api keys

1. Follow the Braintree documentation to create a new user, with the following configuration:
   1. Enable API Access.
   2. Assign the role created in Step 2.
   3. Select all merchant accounts for which you would like to send data for.
2. Log-in with this new user and store the following credentials:
   1. Public key
   2. Private key

Step 2: Share credentials with Payrails

1. Share your API credentials in a secured way with Payrails. You can use your preferred secrets manager or vault tool like 1Password Shared Vaults, AWS Secrets Manager or GCP Secrets Manager.
2. If a shared vault is not possible, you can also share credentials over PGP-encrypted file.