Loading...
This feature is available in the United States, Canada, and the United Kingdom.
As an embedded payments partner, you have full control over your portfolio of merchants. This means having insight into their daily business operations as well as the ability to monitor accuracy and compliance in real time to ensure a frictionless customer experience. With our API, you can access critical merchant and account reporting data, edit merchant information, and manage account permissions.
This solution supports the following use cases.
The following integration options are available for this solution:
Partners can use our API to retrieve merchant and account reports, which enables real-time monitoring and management of merchant operations, financial activity, and risk profiles. This includes:
At a high level, retrieving merchant and account reports works like this:
Ways to Retrieve Merchant Data
The following table describes the different requests that can be used to retrieve data.
| API Request | Description |
|---|---|
| Retrieve a List of Merchants | Used to get a list of onboarded merchants in the partner program and their current status. |
| Retrieve Merchant Details | Used to get in-depth demographic details of your merchants, such as obfuscated deposit bank account details. |
| Retrieve a List of Merchant Accounts | Used to get a list of all accounts associated with a merchant. |
| Retrieve Specific Account Details | Used to view permissions, capabilities, balances, processing limits, and payout capabilities for a specific account. |
Partners can also use our API to update merchant data. This includes modifying business details, banking information, and account settings programmatically. All merchant edits are asynchronous, and partners receive webhook notifications once updates are completed.
At a high level, updating merchant data works like this:
Typical Flow for Updating Merchant Data
To try managing merchant accounts, follow the steps in these guides.