Seller Wallet API
Learn how to use the Seller Wallet API
You use the Seller Wallet API to retrieve financial information that is relevant to a Seller's Seller Wallet account. You can obtain financial events, balances, and transfer schedules for Seller Wallet accounts. You can also schedule and initiate transactions.
Release notes
To learn more about the terms that are used on this page, refer to Terminology.
Use cases
The following use case examples are available for the Seller Wallet API:
- Retrieve Seller Wallet account details: Review Seller Wallet account details and balances on a Seller's account.
- Retrieve transaction details: Retrieve transaction details for a Seller Wallet account.
- Preview fees and initiate a transaction: Preview the potential fees for a transaction based on the source and destination currencies and initiate a transaction.
- Manage transfer schedules for a Seller Wallet account: Retrieve all transfer schedules for a Seller Wallet account, and create, update, or delete transfer schedules.
Roles for the Seller Wallet API v2024-03-01
listAccounts
| Attribute | Value |
|---|---|
| Regions | NA, EU, FE |
| Required roles (need at least one) | Account Information Service Provider |
getAccount
| Attribute | Value |
|---|---|
| Regions | NA, EU, FE |
| Required roles (need at least one) | Account Information Service Provider |
listAccountBalances
| Attribute | Value |
|---|---|
| Regions | NA, EU, FE |
| Required roles (need at least one) | Account Information Service Provider |
getTransferPreview
| Attribute | Value |
|---|---|
| Regions | NA, EU, FE |
| Required roles (need at least one) | Account Information Service Provider |
listAccountTransactions
| Attribute | Value |
|---|---|
| Regions | NA, EU, FE |
| Required roles (need at least one) | Account Information Service Provider |
createTransaction
| Attribute | Value |
|---|---|
| Regions | NA, EU, FE |
| Required roles (need at least one) | Account Information Service Provider Payment Initiation Service Provider |
getTransaction
| Attribute | Value |
|---|---|
| Regions | NA, EU, FE |
| Required roles (need at least one) | Account Information Service Provider |
listTransferSchedules
| Attribute | Value |
|---|---|
| Regions | NA, EU, FE |
| Required roles (need at least one) | Account Information Service Provider |
createTransferSchedule
| Attribute | Value |
|---|---|
| Regions | NA, EU, FE |
| Required roles (need at least one) | Account Information Service Provider Payment Initiation Service Provider |
updateTransferSchedule
| Attribute | Value |
|---|---|
| Regions | NA, EU, FE |
| Required roles (need at least one) | Account Information Service Provider Payment Initiation Service Provider |
getTransferSchedule
| Attribute | Value |
|---|---|
| Regions | NA, EU, FE |
| Required roles (need at least one) | Account Information Service Provider |
deleteScheduleTransaction
| Attribute | Value |
|---|---|
| Regions | NA, EU, FE |
| Required roles (need at least one) | Account Information Service Provider Payment Initiation Service Provider |
Updated 22 days ago