Skip to main content

After this article

You’ll be able to connect Braintree to Lumos to sync users and their roles for visibility and Access Reviews. Braintree is a read-only integration today.

Capabilities

If you require user provisioning, Braintree follows the SCIM format so the generic SCIM connector will allow provisioning to Braintree. See Connecting SCIM Apps with Lumos. Lumos syncs users and roles on its regular integration sync schedule, and connecting or reconnecting the integration starts a sync right away. To refresh sooner, see Triggering Syncs Deep Dive.

Required plan and roles

You authenticate with Braintree API credentials generated in your Braintree gateway. Create the credentials as a Braintree admin, then enter them on the connector card in Lumos. The API key must belong to a Braintree user whose role has the Manage Users and Manage Roles permissions, such as an Account Admin. This is a read-only connection. Lumos reads users from Braintree and doesn’t write changes back.

Read-only access vs provisioning

Is read-only possible? Yes, and it’s the only mode available today. Braintree connects with API credentials generated in your Braintree gateway, and Lumos only reads users from Braintree, it doesn’t write anything back.

Instructions

Phase 1: Get your Braintree credentials
  1. Log in to your Braintree gateway as an admin.
  2. Click the gear icon in the top right corner, then click API.
  3. In the table of API keys, click View on the row of an existing API key, then copy its public key and private key.
  4. Click the gear icon again, then click Business, and copy your Merchant ID.
Phase 2: Connect in Lumos
  1. Find the Braintree card in your Lumos integrations (reconnect an existing card or add a new one).
  2. Enter the values you copied:
    • Merchant ID: your Braintree Merchant ID.
    • Public Key: the API key’s public key.
    • Private Key: the API key’s private key.
    • Sandbox: turn this on only if you’re connecting a Braintree sandbox account. Leave it off for production.
  3. Click Connect.

Troubleshooting

Connection fails. Confirm the public key and private key come from the same API key, that the Merchant ID belongs to the same gateway account, and that Sandbox matches the environment the keys were created in. Lumos calls the sandbox or production API based on that setting. If the connection still fails, contact support@lumos.com.