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.
localitystrThe locality/city.
postal_codestrThe postal code.
regionstrThe state or province.
The street address.
dba_namestrThe "Doing Business As" name.
legal_namestrThe legal name.
tax_idstrThe 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.
defaultboolWhether 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.
descriptorstrThe value that determines the description that will appear on a sub-merchant's bank statement for deposits.
destinationstrThe way in which funds will be delivered to a specific sub-merchant. Learn more about sub-merchant funding.
emailstrThe email address.
mobile_phonestrThe mobile phone number.
The numeric string representing a specific bank.
idstrSpecifies 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.
localitystrThe locality/city.
postal_codestrThe postal code.
regionstrThe state or province.
The street address.
The applicant's date of birth.
emailstrEmail address composed of ASCII characters.
first_namestrThe first name.
last_namestrThe last name.
phonestrThe phone number.
ssn_last_4strThe last 4 digits of the applicant's social security number (SSN).
The master merchant account that the sub-merchant account belongs to.
statusstrThe 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_errorsExamples
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.