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.
getAddressDetails()stringBusiness address information specific to a particular sub-merchant.
getLocality()stringThe locality/city.
getPostalCode()stringThe postal code.
getRegion()stringThe state or province.
getStreetAddress()stringThe street address.
getDbaName()stringThe "Doing Business As" name.
getLegalName()stringThe legal name.
getTaxId()stringThe 9-digit numeric value associated with the business' tax identity.
getCurrencyIsoCode()stringThe ISO code for the currency the merchant account uses. See the ISO 4217 codes.
isDefault()booleanWhether transactions will be run using this merchant account by default.
Funding information specific to an Active sub-merchant.
getAccountNumberLast4()stringThe last 4 digits of the applicant's checking account number.
getDescriptor()stringThe value that determines the description that will appear on a sub-merchant's bank statement for deposits.
getDestination()stringThe way in which funds will be delivered to a specific sub-merchant. Learn more about sub-merchant funding.
getEmail()stringThe email address.
getMobilePhone()stringThe mobile phone number.
getRoutingNumber()stringThe numeric string representing a specific bank.
getId()stringSpecifies 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.
getLocality()stringThe locality/city.
getPostalCode()stringThe postal code.
getRegion()stringThe state or province.
getStreetAddress()stringThe street address.
getDateOfBirth()stringThe applicant's date of birth.
getEmail()stringEmail address composed of ASCII characters.
getFirstName()stringThe first name.
getLastName()stringThe last name.
getPhone()stringThe phone number.
getSsnLast4()stringThe last 4 digits of the applicant's social security number (SSN).
The master merchant account that the sub-merchant account belongs to.
getStatus()stringThe 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.
- 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; // trueUnsuccessful 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();