Merchant Account

Merchant Account: Update

See also the Merchant Account response object.

Ruby

result = gateway.merchant_account.update(
  "blue_ladders_store",
  :individual => {
    :first_name => "Jane"
  }
)
if result.success?
  p "Merchant account successfully updated"
else
  p result.errors
end

If the merchant account can't be found, it will raise a Braintree::NotFoundError.

Arguments

idrequired, String

The ID of the sub-merchant.

Additional Parameters

:applicant_details

This functionality still exists in the gateway but is no longer documented. Will remove this param/attr when the corresponding gateway code is removed.

:account_numberString

This functionality still exists in the gateway but is no longer documented. Will remove this param/attr when the corresponding gateway code is removed.

:address

This functionality still exists in the gateway but is no longer documented. Will remove this param/attr when the corresponding gateway code is removed.

:extended_addressString

This functionality still exists in the gateway but is no longer documented. Will remove this param/attr when the corresponding gateway code is removed.

:localityString

This functionality still exists in the gateway but is no longer documented. Will remove this param/attr when the corresponding gateway code is removed.

:postal_codeString

This functionality still exists in the gateway but is no longer documented. Will remove this param/attr when the corresponding gateway code is removed.

:regionString

This functionality still exists in the gateway but is no longer documented. Will remove this param/attr when the corresponding gateway code is removed.

:street_addressString

This functionality still exists in the gateway but is no longer documented. Will remove this param/attr when the corresponding gateway code is removed.

:company_nameString

This functionality still exists in the gateway but is no longer documented. Will remove this param/attr when the corresponding gateway code is removed.

:date_of_birthString

This functionality still exists in the gateway but is no longer documented. Will remove this param/attr when the corresponding gateway code is removed.

:emailString

This functionality still exists in the gateway but is no longer documented. Will remove this param/attr when the corresponding gateway code is removed.

:first_nameString

This functionality still exists in the gateway but is no longer documented. Will remove this param/attr when the corresponding gateway code is removed.

:last_nameString

This functionality still exists in the gateway but is no longer documented. Will remove this param/attr when the corresponding gateway code is removed.

:phoneString

This functionality still exists in the gateway but is no longer documented. Will remove this param/attr when the corresponding gateway code is removed.

:routing_numberString

This functionality still exists in the gateway but is no longer documented. Will remove this param/attr when the corresponding gateway code is removed.

:ssnString

This functionality still exists in the gateway but is no longer documented. Will remove this param/attr when the corresponding gateway code is removed.

:tax_idString

This functionality still exists in the gateway but is no longer documented. Will remove this param/attr when the corresponding gateway code is removed.

:business

Only available for Braintree Marketplace accounts. Business information associated with a sub-merchant.

:addressString

Only available for Braintree Marketplace accounts. Business information associated with a sub-merchant.

:localityString

The locality/city. 255 character maximum.

:postal_codeString

The postal code. Postal code must be a string of 4-9 alphanumeric characters, optionally separated by a dash or a space. Spaces and hyphens are ignored.

:regionString

The state or province. For PayPal addresses, the region must meet PayPal's state restrictions; for all other payment methods, it must be less than or equal to 255 characters.

:street_addressString

The street address. Street address must be less than or equal to 255 characters.

:dba_nameString

The "Doing Business As" name. The company name must contain only letters, numbers, ampersands (&) hyphens (-), exclamation marks (!), at symbols (@), hashtag (#), dollar sign ($), beginning and end parentheses ( '(' and ')' ), single quotation mark ('), period (.), forward slash (/), plus symbol (+), comma (,) and double quotation mark ("). 40 character maximum.

:legal_nameString

The legal name. The applicant's legal name must contain only letters, numbers, ampersands (&) hyphens (-), exclamation marks (!), at symbols (@), hashtag (#), dollar sign ($), beginning and end parentheses ( '(' and ')' ), single quotation mark ('), period (.), forward slash (/), plus symbol (+), comma (,) and double quotation mark ("). 40 character maximum. Required if business information has been provided.

:tax_idString

The 9-digit numeric value associated with the business' tax identity. Required if business information has been provided.

:funding

Details of where funds will be disbursed for a sub-merchant.

:account_numberString

The value representing a checking account number. It is required if the request's funding destination is bank.

:descriptorString

The value that determines the business description that will appear on a sub-merchant's bank statement for deposits. If one is not provided, the gateway will generate one based on applicant name, business legal name, or DBA name. 22 character maximum.

:destinationString

The way in which funds will be delivered to a specific sub-merchant. Specify bank to disburse funds into the checking account associated with the provided account and routing numbers. Venmo funding destinations (email and mobile_phone) are no longer supported for new merchants. Any sub-merchant that is already using a Venmo destination may continue to do so, and the funding details for those accounts can still be updated. Learn more about sub-merchant funding.

:emailString

The email address composed of ASCII characters.

:mobile_phoneString

The mobile phone number. Phone must be 10 - 14 characters and can only contain numbers, hyphens and parentheses.

:routing_numberString

The numeric value representing a specific bank. Required if funding destination is bank.

:individual

Individual information associated with a sub-merchant.

:addressString

Individual address information associated with a sub-merchant.

:localityString

The locality/city. 255 character maximum.

:postal_codeString

The postal code. Postal code must be a string of 4-9 alphanumeric characters, optionally separated by a dash or a space. Spaces and hyphens are ignored.

:regionString

The state or province. For PayPal addresses, the region must meet PayPal's state restrictions; for all other payment methods, it must be less than or equal to 255 characters.

:street_addressString

The street address. Street address must be less than or equal to 255 characters.

:date_of_birthString

The applicant's date of birth. Values can be passed as YYYYMMDD or YYYY-MM-DD.

:emailString

Email address composed of ASCII characters.

:first_nameString

The first name. The first name value must be less than or equal to 255 characters.

:last_nameString

The last name. The last name value must be less than or equal to 255 characters.

:phoneString

Phone number. Phone must be 10-14 characters and can only contain numbers, hyphens and parentheses.

:ssnString

The full 9-digit Social Security Number is required if the sub-merchant is not a registered business.. The value may be passed with or without dashes. If an SSN is not provided, we will attempt to retrieve the SSN based on other information.