Merchant Account
Server-side response object returned directly or within a successful result object from the following requests:
Attributes
Business information specific to an Active
sub-merchant.
Business address information specific to a particular sub-merchant.
locality
strThe locality/city.
postal_code
strThe postal code.
region
strThe state or province.
The street address.
dba_name
strThe "Doing Business As" name.
legal_name
strThe legal name.
tax_id
strThe 9-digit numeric value associated with the business' tax identity.
The ISO code for the currency the merchant account uses. See the ISO 4217 codes.
default
boolWhether transactions will be run using this merchant account by default.
Funding information specific to an Active
sub-merchant.
The last 4 digits of the applicant's checking account number.
descriptor
strThe value that determines the description that will appear on a sub-merchant's bank statement for deposits.
destination
strThe way in which funds will be delivered to a specific sub-merchant. Learn more about sub-merchant funding.
email
strThe email address.
mobile_phone
strThe mobile phone number.
The numeric string representing a specific bank.
id
strSpecifies the ID of the sub-merchant, which can be referenced when creating transactions with service fees.
Information specific to an Active
sub-merchant.
Address information specific to a particular sub-merchant.
locality
strThe locality/city.
postal_code
strThe postal code.
region
strThe state or province.
The street address.
The applicant's date of birth.
email
strEmail address composed of ASCII characters.
first_name
strThe first name.
last_name
strThe last name.
phone
strThe phone number.
ssn_last_4
strThe last 4 digits of the applicant's social security number (SSN).
The master merchant account that the sub-merchant account belongs to.
status
strThe 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 apending 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 provides you with fraud protection 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.
- Python
result.is_success
# True
result.merchant_account.status
# "pending"
result.merchant_account.id
# "blue_ladders_store"
result.merchant_account.master_merchant_account.id
# "14ladders_marketplace"
result.merchant_account.master_merchant_account.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.
- Python
result.is_success
# False
result.errors.deep_errors