Returned directly or within a successful result object from the following requests:
- Merchant Account: Create
- Merchant Account: Create For Currency
- Merchant Account: All
- Merchant Account: Update
- Merchant Account: Find
Attributes
CurrencyIsoCode
string
The ISO code for the currency the merchant account uses. See the ISO 4217 codes.
Descriptor
string
The value that determines the description that will appear on a sub-merchant's bank statement for deposits.
Destination
string
The way in which funds will be delivered to a specific sub-merchant. Learn more about sub-merchant funding.
Id
string
Specifies the ID of the sub-merchant, which can be referenced when creating transactions with service fees.
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.
result.IsSuccess();
// true
MerchantAccount ma = result.Target;
ma.Status == MerchantAccountStatus.PENDING
// true
ma.Id;
// "blue_ladders_store"
ma.MasterMerchantAccount.Id;
// "14ladders_marketplace"
ma.MasterMerchantAccount.Status == MerchantAccountStatus.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.
if (!result.IsSuccess())
{
ValidationErrors errors = result.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.