Merchant Account

Returned directly or within a successful result object from the following requests:
`Merchant Account: All`
`Merchant Account: Create`
`Merchant Account: Create For Currency`
`Merchant Account: Find`
`Merchant Account: Update`

Attributes

getBusinessDetails()map

Business information specific to an Active sub-merchant.

getAddressDetails()string

Business address information specific to a particular sub-merchant.

getLocality()string

The locality/city.

getPostalCode()string

The postal code.

getRegion()string

The state or province.

getStreetAddress()string

The street address.

getDbaName()string

The "Doing Business As" name.

getLegalName()string

The legal name.

getTaxId()string

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

getCurrencyIsoCode()string

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

isDefault()boolean

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

getFundingDetails()map

Funding information specific to an Active sub-merchant.

getAccountNumberLast4()string

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

getDescriptor()string

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

getDestination()string

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

getEmail()string

The email address.

getMobilePhone()string

The mobile phone number.

getRoutingNumber()string

The numeric string representing a specific bank.

getId()string

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

getIndividualDetails()map

Information specific to an Active sub-merchant.

getAddressDetails()map

Address information specific to a particular sub-merchant.

getLocality()string

The locality/city.

getPostalCode()string

The postal code.

getRegion()string

The state or province.

getStreetAddress()string

The street address.

getDateOfBirth()string

The applicant's date of birth.

getEmail()string

Email address composed of ASCII characters.

getFirstName()string

The first name.

getLastName()string

The last name.

getPhone()string

The phone number.

getSsnLast4()string

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

getMasterMerchantAccount()obj

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

getStatus()string

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.

Java

result.isSuccess();
// true
MerchantAccount ma = result.getTarget();
ma.getStatus() == MerchantAccount.Status.PENDING;
// true
ma.getId();
// "blue_ladders_store"
ma.getMasterMerchantAccount.getId();
// "14ladders_marketplace"
ma.getMasterMerchantAccount.getStatus() == MerchantAccount.Status.ACTIVE;
// true

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.

Java

result.isSuccess();
// false

ValidationErrors errors = result.getErrors();

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.