List e-wallet transactions

POST /wallet/transaction/list

This endpoint lists the latest transactions of the specified e-wallet. Transactions are returned in descending order by the created_at time.

Request Body

Required

WalletTransactionListRequest defines the request schema for /wallet/transaction/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.
wallet_id
required, string
The ID of the e-wallet to fetch transactions from
cursor
string
A value representing the latest transaction to be included in the response. Set this from next_cursor received in the previous /wallet/transaction/list request. If provided, the response will only contain that transaction and transactions created before it. If omitted, the response will contain transactions starting from the most recent, and in descending order by the created_at time.
count
integer
The number of transactions to fetch
options
object
Additional wallet transaction options
start_time
string
Timestamp in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ) for filtering transactions, inclusive of the provided date.
end_time
string
Timestamp in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ) for filtering transactions, inclusive of the provided date.

Response

WalletTransactionListResponse defines the response schema for /wallet/transaction/list

Response Properties

transactions
required, array[object]
An array of transactions of an e-wallet, associated with the given wallet_id
transaction_id
required, string
A unique ID identifying the transaction
wallet_id
required, string
The EMI (E-Money Institution) wallet that this payment is associated with, if any. This wallet is used as an intermediary account to enable Plaid to reconcile the settlement of funds for Payment Initiation requests.
reference
required, string
A reference for the transaction
type
required, string
The type of the transaction. The supported transaction types that are returned are: BANK_TRANSFER: a transaction which credits an e-wallet through an external bank transfer. PAYOUT: a transaction which debits an e-wallet by disbursing funds to a counterparty. PIS_PAY_IN: a payment which credits an e-wallet through Plaid’s Payment Initiation Services (PIS) APIs. For more information see the Payment Initiation endpoints. REFUND: a transaction which debits an e-wallet by refunding a previously initiated payment made through Plaid’s PIS APIs. FUNDS_SWEEP: an automated transaction which debits funds from an e-wallet to a designated client-owned account. RETURN: an automated transaction where a debit transaction was reversed and money moved back to originating account. RECALL: a transaction where the sending bank has requested the return of funds due to a fraud claim, technical error, or other issue associated with the payment.
scheme
string
The payment scheme used to execute this transaction. This is present only for transaction types PAYOUT and REFUND. FASTER_PAYMENTS: The standard payment scheme within the UK. SEPA_CREDIT_TRANSFER: The standard payment to a beneficiary within the SEPA area. SEPA_CREDIT_TRANSFER_INSTANT: Instant payment to a beneficiary within the SEPA area.
amount
required, object
The amount and currency of a transaction
iso_currency_code
required, string
An ISO-4217 currency code, used with e-wallets and transactions.
value
required, number
The amount of the transaction. Must contain at most two digits of precision e.g. 1.23.
counterparty
required, object
An object representing the e-wallet transaction’s counterparty
name
required, string
The name of the counterparty
numbers
required, object
The counterparty’s bank account numbers. Exactly one of IBAN or BACS data is required.
bacs
object
The account number and sort code of the counterparty’s account
international
object
International Bank Account Number for a Wallet Transaction
iban
string
International Bank Account Number (IBAN).
address
object
The optional address of the payment recipient’s bank account. Required by most institutions outside of the UK.
street
required, array[string]
An array of length 1-2 representing the street address where the recipient is located. Maximum of 70 characters.
city
required, string
The city where the recipient is located. Maximum of 35 characters.
postal_code
required, string
The postal code where the recipient is located. Maximum of 16 characters.
country
required, string
The ISO 3166-1 alpha-2 country code where the recipient is located.
date_of_birth
string
The counterparty’s birthdate, in ISO 8601 (YYYY-MM-DD) format.
status
required, string
The status of the transaction. AUTHORISING: The transaction is being processed for validation and compliance. INITIATED: The transaction has been initiated and is currently being processed. EXECUTED: The transaction has been successfully executed and is considered complete. This is only applicable for debit transactions. SETTLED: The transaction has settled and funds are available for use. This is only applicable for credit transactions. A transaction will typically settle within seconds to several days, depending on which payment rail is used. FAILED: The transaction failed to process successfully. This is a terminal status. BLOCKED: The transaction has been blocked for violating compliance rules. This is a terminal status.
created_at
required, string
Timestamp when the transaction was created, in ISO 8601 format.
last_status_update
required, string
The date and time of the last time the status was updated, in IS0 8601 format
payment_id
string
The payment id that this transaction is associated with, if any. This is present only for transaction types PIS_PAY_IN and REFUND.
failure_reason
string
The error code of a failed transaction. Error codes include: EXTERNAL_SYSTEM: The transaction was declined by an external system. EXPIRED: The transaction request has expired. CANCELLED: The transaction request was rescinded. INVALID: The transaction did not meet certain criteria, such as an inactive account or no valid counterparty, etc. UNKNOWN: The transaction was unsuccessful, but the exact cause is unknown.
error
object
Errors are identified by error_code and categorized by error_type. Use these in preference to HTTP status codes to identify and handle specific errors. HTTP status codes are set and provide the broadest categorization of errors: 4xx codes are for developer- or user-related errors, and 5xx codes are for Plaid-related errors, and the status will be 2xx in non-error cases. An Item with a non-null error object will only be part of an API response when calling /item/get to view Item status. Otherwise, error fields will be null if no error has occurred; if an error has occurred, an error code will be returned instead.
error_type
required, string
A broad categorization of the error. Safe for programmatic use.
error_code
required, string
The particular error code. Safe for programmatic use.
error_code_reason
string
The specific reason for the error code. Currently, reasons are only supported OAuth-based item errors; null will be returned otherwise. Safe for programmatic use. Possible values: OAUTH_INVALID_TOKEN: The user’s OAuth connection to this institution has been invalidated. OAUTH_CONSENT_EXPIRED: The user’s access consent for this OAuth connection to this institution has expired. OAUTH_USER_REVOKED: The user’s OAuth connection to this institution is invalid because the user revoked their connection.
error_message
required, string
A developer-friendly representation of the error code. This may change over time and is not safe for programmatic use.
display_message
required, string
A user-friendly representation of the error code. null if the error is not related to user action. This may change over time and is not safe for programmatic use.
request_id
string
A unique ID identifying the request, to be used for troubleshooting purposes. This field will be omitted in errors provided by webhooks.
causes
array
In this product, a request can pertain to more than one Item. If an error is returned for such a request, causes will return an array of errors containing a breakdown of these errors on the individual Item level, if any can be identified. causes will be provided for the error_type ASSET_REPORT_ERROR or CHECK_REPORT_ERROR. causes will also not be populated inside an error nested within a warning object.
status
integer
The HTTP status code associated with the error. This will only be returned in the response body when the error information is provided via a webhook.
documentation_url
string
The URL of a Plaid documentation page with more information about the error
suggested_action
string
Suggested steps for resolving the error
related_transactions
array[object]
A list of wallet transactions that this transaction is associated with, if any.
id
string
The ID of the related transaction.
type
string
The type of the transaction.
next_cursor
string
The value that, when used as the optional cursor parameter to /wallet/transaction/list, will return the corresponding transaction as its first entry.
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.