availability

If you're a new merchant looking for a marketplace solution, contact our Sales team.

To update a sub-merchant, you must specify the merchantAccountId along with the attributes to be changed. Any attributes not passed in the update call will remain unchanged.

Node.js
var merchantAccountParams = {
  individual: {
    firstName: "Jane"
  }
};

gateway.merchantAccount.update("blue_ladder_store", merchantAccountParams, function (err, result) {
  result.success;
  // true
});

If the merchant account can't be found, it will return a notFoundError.

You can update the sub-merchant details that fall under these 3 attributes:

  • individual
  • business
  • funding

Individual details

Every sub-merchant must have an individual tied to that account. To update or replace the individual information, pass in the details via a merchant account update call as follows:

Node.js
var merchantAccountParams = {
  individual: {
    firstName: "Jane",
    lastName: "Doe",
    email: "jane@14ladders.com",
    phone: "5553334444",
    dateOfBirth: "1981-11-19",
    ssn: "456-45-4567",
    address: {
      streetAddress: "111 Main St",
      locality: "Chicago",
      region: "IL",
      postalCode: "60622"
    }
  }
};

gateway.merchantAccount.update("blue_ladder_store", merchantAccountParams, function (err, result) {
  result.merchantAccount.individual.firstName;
  // Jane
});

Only the last 4 digits of the SSN will be returned after a successful update since the field contains sensitive data.

Business details

If the sub-merchant is a registered business, you can update the DBA name, legal name, tax ID, and address fields.

Node.js
var merchantAccountParams = {
  business: {
    legalName: "Jane's Ladders",
    dbaName: "Jane's Ladders",
    taxId: "98-7654321",
    address: {
      streetAddress: "111 Main St",
      locality: "Chicago",
      region: "IL",
      postalCode: "60622"
    }
  }
};

gateway.merchantAccount.update("blue_ladder_store", merchantAccountParams, function (err, result) {
  result.merchantAccount.business.legalName;
  // Jane's Ladders
});

Note that the business details are optional and are in addition to the individual details that are always required. See Onboarding Sub-merchants for more information.

Funding details

The funding section controls where Braintree will disburse the settled funds. The fields can be updated as follows:

Node.js
var merchantAccountParams = {
  funding: {
    descriptor: "Blue Ladders",
    destination: braintree.MerchantAccount.FundingDestination.Bank,
    email: "funding@blueladders.com",
    mobilePhone: "5555555555",
    accountNumber: "1123581321",
    routingNumber: "071101307"
  }
};

gateway.merchantAccount.update("blue_ladder_store", merchantAccountParams, function (err, result) {
  result.merchantAccount.funding.routingNumber;
  // 071101307
});

Only the last 4 digits of the account number will be returned after a successful update since the field contains sensitive data.

See also