Returned within a successful result object from the following requests:

Attributes
businessDetails

Business information specific to an Active sub-merchant.

addressDetails string

Business address information specific to a particular sub-merchant.

locality string

The locality/city.

postalCode string

The postal code.

region string

The state or province.

streetAddress string

The street address.

dbaName string

The "Doing Business As" name.

legalName string

The legal name.

taxId string

The 9-digit numeric value associated with the business' tax identity.

currencyIsoCode string

The ISO code for the currency the merchant account uses. See the ISO 4217 codes.

default bool

Whether transactions will be run using this merchant account by default.

fundingDetails

Funding information specific to an Active sub-merchant.

accountNumberLast4 string

The last 4 digits of the applicant's checking account number.

descriptor string

The value that determines the description that will appear on a sub-merchant's bank statement for deposits.

destination string

The way in which funds will be delivered to a specific sub-merchant. Learn more about sub-merchant funding.

email string

The email address.

mobilePhone string

The mobile phone number.

routingNumber string

The numeric string representing a specific bank.

id string

Specifies the ID of the sub-merchant, which can be referenced when creating transactions with service fees.

individualDetails

Information specific to an Active sub-merchant.

addressDetails

Address information specific to a particular sub-merchant.

locality string

The locality/city.

postalCode string

The postal code.

region string

The state or province.

streetAddress string

The street address.

dateOfBirth string

The applicant's date of birth.

email string

Email address composed of ASCII characters.

firstName string

The first name.

lastName string

The last name.

phone string

The phone number.

ssnLast4 string

The last 4 digits of the applicant's social security number (SSN).

masterMerchantAccount

The master merchant account that the sub-merchant account belongs to.

status string

The state of the merchant account can either be Pending, Active, or Suspended.

Result Object

A merchant account result may be successful or unsuccessful. Learn more about result objects.

Successful result

If the result was successful, the merchant account will have a pending status. Within several minutes you should expect to receive a confirmation webhook.

The sub-merchant and its master merchant account will be provided on the result.

The sub-merchant status is pending at this point because (in production) we are taking the data provided, securely contacting a number of third-party services to verify the information and making sure there are no red flags. This is done to protect you and Braintree from fraud while also satisfying our standard risk and underwriting process for new Merchants. This means that a response will be delayed by just a minute or two (in production), so you will need to use webhooks to listen for a response and confirm that the sub-merchant has successfully passed these checks.

PHP
$result->success;
// true
$result->merchantAccount->status;
// "pending"
$result->merchantAccount->id;
// "blue_ladders_store"
$result->merchantAccount->masterMerchantAccount->id;
// "14ladders_marketplace"
$result->merchantAccount->masterMerchantAccount->status;
// "active"

Unsuccessful result

Success will return false if validations prevent the merchant account from on-boarding. To simulate unsuccessful API calls in Sandbox check out our test values for merchant account creation.

Validation errors

If any parameters are invalid, then the success call will return false and the result object will contain validation errors indicating which parameters were invalid.

PHP
$result->success
# false

$result->errors->deepAll()

Examples

Statuses

Pending

The merchant account is in the process of verification with several third-party services. This is a transitory state. It will become active or suspended after verification.

Active

The merchant account has been approved. It can be used for processing transactions.

Suspended

The merchant account has been declined. It cannot be used for processing transactions.

Still have questions?

If you can’t find an answer, contact our Support team.