Fetch a list of e-wallets

POST /wallet/list

This endpoint lists all e-wallets in descending order of creation.

Request Body

Required

WalletListRequest defines the request schema for /wallet/list

Parameters

client_id
string
Your Plaid API client_id. The client_id is required and may be provided either in the PLAID-CLIENT-ID header or as part of a request body.
secret
string
Your Plaid API secret. The secret is required and may be provided either in the PLAID-SECRET header or as part of a request body.
iso_currency_code
string
An ISO-4217 currency code, used with e-wallets and transactions.
cursor
string
A base64 value representing the latest e-wallet that has already been requested. Set this to next_cursor received from the previous /wallet/list request. If provided, the response will only contain e-wallets created before that e-wallet. If omitted, the response will contain e-wallets starting from the most recent, and in descending order.
count
integer
The number of e-wallets to fetch

Response

WalletListResponse defines the response schema for /wallet/list

Response Properties

wallets
required, array[object]
An array of e-wallets
wallet_id
required, string
A unique ID identifying the e-wallet
balance
required, object
An object representing the e-wallet balance
iso_currency_code
required, string
The ISO-4217 currency code of the balance
current
required, number
The total amount of funds in the account
available
required, number
The total amount of funds in the account after subtracting pending debit transaction amounts
numbers
required, object
An object representing the e-wallet account numbers
bacs
object
An object containing a BACS account number and sort code. If an IBAN is not provided or if you need to accept domestic GBP-denominated payments, BACS data is required.
account
string
The account number of the account. Maximum of 10 characters.
sort_code
string
The 6-character sort code of the account.
international
object
Account numbers using the International Bank Account Number and BIC/SWIFT code format.
iban
required, string
International Bank Account Number (IBAN).
bic
required, string
The Business Identifier Code, also known as SWIFT code, for this bank account.
recipient_id
string
The ID of the recipient that corresponds to the e-wallet account numbers
status
required, string
The status of the wallet. UNKNOWN: The wallet status is unknown. ACTIVE: The wallet is active and ready to send money to and receive money from. CLOSED: The wallet is closed. Any transactions made to or from this wallet will error.
next_cursor
string
Cursor used for fetching e-wallets created before the latest e-wallet provided in this response
request_id
required, string
A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.