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
id
required, StringThe ID of the sub-merchant.
Additional Parameters
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_number
StringThis functionality still exists in the gateway but is no longer documented. Will remove this param/attr when the corresponding gateway code is removed.
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_address
StringThis functionality still exists in the gateway but is no longer documented. Will remove this param/attr when the corresponding gateway code is removed.
:locality
StringThis functionality still exists in the gateway but is no longer documented. Will remove this param/attr when the corresponding gateway code is removed.
:postal_code
StringThis functionality still exists in the gateway but is no longer documented. Will remove this param/attr when the corresponding gateway code is removed.
:region
StringThis functionality still exists in the gateway but is no longer documented. Will remove this param/attr when the corresponding gateway code is removed.
:street_address
StringThis functionality still exists in the gateway but is no longer documented. Will remove this param/attr when the corresponding gateway code is removed.
:company_name
StringThis 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_birth
StringThis functionality still exists in the gateway but is no longer documented. Will remove this param/attr when the corresponding gateway code is removed.
:email
StringThis functionality still exists in the gateway but is no longer documented. Will remove this param/attr when the corresponding gateway code is removed.
:first_name
StringThis functionality still exists in the gateway but is no longer documented. Will remove this param/attr when the corresponding gateway code is removed.
:last_name
StringThis functionality still exists in the gateway but is no longer documented. Will remove this param/attr when the corresponding gateway code is removed.
:phone
StringThis functionality still exists in the gateway but is no longer documented. Will remove this param/attr when the corresponding gateway code is removed.
:routing_number
StringThis functionality still exists in the gateway but is no longer documented. Will remove this param/attr when the corresponding gateway code is removed.
:ssn
StringThis functionality still exists in the gateway but is no longer documented. Will remove this param/attr when the corresponding gateway code is removed.
:tax_id
StringThis functionality still exists in the gateway but is no longer documented. Will remove this param/attr when the corresponding gateway code is removed.
Only available for Braintree Marketplace accounts. Business information associated with a sub-merchant.
:address
StringOnly available for Braintree Marketplace accounts. Business information associated with a sub-merchant.
:locality
StringThe locality/city. 255 character maximum.
:postal_code
StringThe 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.
:region
StringThe 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_address
StringThe street address. Street address must be less than or equal to 255 characters.
:dba_name
StringThe "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_name
StringThe 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_id
StringThe 9-digit numeric value associated with the business' tax identity. Required if business information has been provided.
Details of where funds will be disbursed for a sub-merchant.
:account_number
StringThe value representing a checking account number. It is required if the request's funding destination is .
:descriptor
StringThe 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.
:destination
StringThe way in which funds will be delivered to a specific sub-merchant. Specify to disburse funds into the checking account associated with the provided account and routing numbers. Venmo funding destinations ( and ) 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.
:email
StringThe email address composed of ASCII characters.
:mobile_phone
StringThe mobile phone number. Phone must be 10 - 14 characters and can only contain numbers, parentheses, and periods.
:routing_number
StringThe numeric value representing a specific bank. Required if funding destination is .
Individual information associated with a sub-merchant.
:address
StringIndividual address information associated with a sub-merchant.
:locality
StringThe locality/city. 255 character maximum.
:postal_code
StringThe 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.
:region
StringThe 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_address
StringThe street address. Street address must be less than or equal to 255 characters.
:date_of_birth
StringThe applicant's date of birth. Values can be passed as
YYYYMMDD
or YYYY-MM-DD
.:email
StringEmail address composed of ASCII characters.
:first_name
StringThe first name. The first name value must be less than or equal to 255 characters.
:last_name
StringThe last name. The last name value must be less than or equal to 255 characters.
:phone
StringPhone number. Phone must be 10-14 characters and can only contain numbers, dashes, parentheses and periods.
:ssn
StringThe 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.