Returned directly or within a successful result object from the following requests:

Attributes
business_details

Business information specific to an Active sub-merchant.

address_details str

Business address information specific to a particular sub-merchant.

locality str

The locality/city.

postal_code str

The postal code.

region str

The state or province.

street_address str

The street address.

dba_name str

The "Doing Business As" name.

legal_name str

The legal name.

tax_id str

The 9-digit numeric value associated with the business' tax identity.

currency_iso_code str

The ISO code for the currency the merchant account uses. See the ISO 4217 codes.

default bool

Whether transactions will be run using this merchant account by default.

funding_details

Funding information specific to an Active sub-merchant.

account_number_last_4 str

The last 4 digits of the applicant's checking account number.

descriptor str

The value that determines the description that will appear on a sub-merchant's bank statement for deposits.

destination str

The way in which funds will be delivered to a specific sub-merchant. Learn more about sub-merchant funding.

email str

The email address.

mobile_phone str

The mobile phone number.

routing_number str

The numeric string representing a specific bank.

id str

Specifies the ID of the sub-merchant, which can be referenced when creating transactions with service fees.

individual_details

Information specific to an Active sub-merchant.

address_details

Address information specific to a particular sub-merchant.

locality str

The locality/city.

postal_code str

The postal code.

region str

The state or province.

street_address str

The street address.

date_of_birth str

The applicant's date of birth.

email str

Email address composed of ASCII characters.

first_name str

The first name.

last_name str

The last name.

phone str

The phone number.

ssn_last_4 str

The last 4 digits of the applicant's social security number (SSN).

master_merchant_account

The master merchant account that the sub-merchant account belongs to.

status str

The 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 a pending 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

Examples

Statuses

Pending

The merchant account is in the process of verification with several third-party services. This is a transitory state. It will become active or suspended after verification.

Active

The merchant account has been approved. It can be used for processing transactions.

Suspended

The merchant account has been declined. It can't be used for processing transactions.