For merchants who need to sign up for a new Braintree account, you can pre-populate the following fields in the signup form:
||Birth year (YYYY)|
||Birth month (MM)|
||Birth day of month (DD)|
||State or province|
||Name of company|
||State or province|
||Year and month business was established (yyyy-mm)|
||Annual transaction volume amount|
||Average transaction amount|
||Maximum transaction amount|
||Does your company ship physical goods (true/false)|
||Estimated fulfillment completion (days as integer). Should be one of:
If you would prefer that only existing Braintree merchants connect to your platform, you can set up the
connectUrl to allow only logins.
||Only show the login form on the landing page (true/false).|
There are currently three additional OAuth scopes available for Braintree Auth platforms when building the
connectUrl. All of the standard OAuth scopes are also available. To request multiple scopes, use a comma separated string, e.g.
||Allows you to manage disputes for a connected merchant.|
||Allows you to receive Dispute webhooks for a connected merchant.|
||Provides read-only access to the merchant's Braintree account.|
||Provides full read-write control of the merchant's Braintree account.|
It is the unique identifier for the account in Braintree's systems so it can help with support issues. Also, if you wish to deep link to the Braintree Control Panel from your dashboard you will need this ID to construct the URL.
For example, to link to a transaction details page, the URL looks like this:
If your product requires the merchant to download software (such as a downloadable shopping cart) you will need to do a little extra work to prevent shipping software with your
clientId and a
clientSecret embedded, as they should always be kept secret.
One solution is to create an intermediary server that communicates with Braintree on behalf of the merchant:
- When creating your OAuth application, register a redirect URI that points to your intermediary server:
- After the merchant downloads your software, the host URL (e.g.
https://cartuser.com) makes a request to this intermediary server, including the URI where the merchant will be directed at the end of the authorization flow:
- Your intermediary server returns the URI generated by your server, passing an escaped version of the merchant's URI (typically as a URL or base 64 encoded string) in the
- When the merchant clicks Connect with Braintree, the downloaded software redirects the merchant to the Braintree
connectUrlreturned by your intermediary server in #3
- On completing the OAuth flow the merchant is redirected to the intermediary server using the URI registered in #1:
- Your intermediary server inspects the
stateparam of the redirect and uses it to redirect your merchant back to the URI given in the initiating request:
The following validation errors are specific to creating merchant accounts via Braintree Auth. You may receive additional validation errors on other objects; for details on those, see the main validation errors reference.
|Currency passed is not accepted.|
The currency passed is not one of the supported currencies.
|Merchant account was not OAuth onboarded.|
Merchant was not onboarded through Braintree Auth.
|Company name is not valid|
The applicant's company name must contain only letters, numbers, and these characters:
|Email is required.|
Email is required.
|Email is invalid.|
Email is invalid.
|Merchant must have a country code (alpha2, alpha3, numeric or name)|
Merchant must have a country code (alpha2, alpha3, numeric or name)
|Country code (alpha3) is not an accepted country.|
Country code (alpha3) is not an accepted country.
|Country code (alpha3) is not a valid country|
Country code (alpha3) is not a valid country
|Country code (alpha2) is not an accepted country.|
Country code (alpha2) is not an accepted country.
|Country code (alpha2) is not a valid country|
Country code (alpha2) is not a valid country
|Country code (numeric) is not an accepted country.|
Country code (numeric) is not an accepted country.
|Country code (numeric) is not a valid country|
Country code (numeric) is not a valid country
|Country name is not an accepted country.|
Country name is not an accepted country.
|Country name is not a valid country|
Country name is not a valid country
|Provided country information is inconsistent.|
Provided country information is inconsistent.
|One or more payment methods passed are not accepted.|
One or more payment methods passed are not accepted.
|One or more currencies passed are not accepted.|
One or more currencies passed are not accepted.
|One or more payment methods passed are not allowed.|
One or more payment methods passed are not allowed.
|A merchant account already exists for that currency.|
A merchant account already exists for that currency.
|You must pass in a valid currency.|
You must pass in a valid currency.
|No merchant accounts exist for merchant.|
No merchant accounts exist for merchant.
|A merchant account already exists for the id.|
A merchant account already exists for the id.