Merchant Account

Merchant Account: Update

See also the Merchant Account response object.

  1. Python
result = gateway.merchant_account.update(
    'blue_ladders_store',
    {
        'individual': {
            'first_name': 'Jane'
        }
    }
)

if result.is_success:
    print "Merchant account successfully updated"
else:
    print(result.errors)

If the merchant account can't be found, it will throw a NotFoundError exception.

Arguments
idrequired, str
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_number'str
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_address'str
This functionality still exists in the gateway but is no longer documented. Will remove this param/attr when the corresponding gateway code is removed.
'locality'str
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_code'str
This functionality still exists in the gateway but is no longer documented. Will remove this param/attr when the corresponding gateway code is removed.
'region'str
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_address'str
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_name'str
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_birth'str
This functionality still exists in the gateway but is no longer documented. Will remove this param/attr when the corresponding gateway code is removed.
'email'str
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_name'str
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_name'str
This functionality still exists in the gateway but is no longer documented. Will remove this param/attr when the corresponding gateway code is removed.
'phone'str
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_number'str
This functionality still exists in the gateway but is no longer documented. Will remove this param/attr when the corresponding gateway code is removed.
'ssn'str
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_id'str
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.
'address'str
Only available for Braintree Marketplace accounts. Business information associated with a sub-merchant.
'locality'str
The locality/city. 255 character maximum.
'postal_code'str
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.
'region'str
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_address'str
The street address. Street address must be less than or equal to 255 characters.
'dba_name'str

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.

'tax_id'str
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_number'str

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

'descriptor'str
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.
'destination'str

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.

'email'str
The email address composed of ASCII characters.
'mobile_phone'str
The mobile phone number. Phone must be 10 - 14 characters and can only contain numbers, hyphens and parentheses.
'routing_number'str

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

'individual'
Individual information associated with a sub-merchant.
'address'str
Individual address information associated with a sub-merchant.
'locality'str
The locality/city. 255 character maximum.
'postal_code'str
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.
'region'str
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_address'str
The street address. Street address must be less than or equal to 255 characters.
'date_of_birth'str
The applicant's date of birth. Values can be passed as YYYYMMDD or YYYY-MM-DD.
'email'str
Email address composed of ASCII characters.
'first_name'str
The first name. The first name value must be less than or equal to 255 characters.
'last_name'str
The last name. The last name value must be less than or equal to 255 characters.
'phone'str
Phone number. Phone must be 10-14 characters and can only contain numbers, hyphens and parentheses.
'ssn'str
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.

See also