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
The ISO code for the currency the merchant account uses. See the ISO 4217 codes.
The value that determines the description that will appear on a sub-merchant's bank statement for deposits.
The way in which funds will be delivered to a specific sub-merchant. Learn more about sub-merchant funding.
Specifies the ID of the sub-merchant, which can be referenced when creating transactions with service fees.
A merchant account result may be successful or unsuccessful. Learn more about result objects.
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.success; // true result.merchantAccount.status // "pending" result.merchantAccount.id // "blueLaddersStore" result.merchantAccount.masterMerchantAccount.id // "14laddersMarketplace" result.merchantAccount.masterMerchantAccount.status // "active"
result.success; // false result.errors.deepErrors();
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.
The merchant account has been approved. It can be used for processing transactions.
The merchant account has been declined. It can't be used for processing transactions.