Refresh transaction data

POST /processor/transactions/refresh

/processor/transactions/refresh is an optional endpoint for users of the Transactions product. It initiates an on-demand extraction to fetch the newest transactions for a processor token. This on-demand extraction takes place in addition to the periodic extractions that automatically occur one or more times per day for any Transactions-enabled processor token. If changes to transactions are discovered after calling /processor/transactions/refresh, Plaid will fire a webhook: for /transactions/sync users, SYNC_UPDATES_AVAILABLE will be fired if there are any transactions updated, added, or removed. For users of both /processor/transactions/sync and /processor/transactions/get, TRANSACTIONS_REMOVED will be fired if any removed transactions are detected, and DEFAULT_UPDATE will be fired if any new transactions are detected. New transactions can be fetched by calling /processor/transactions/get or /processor/transactions/sync. Note that the /transactions/refresh endpoint is not supported for Capital One (ins_128026) non-depository accounts and will result in a PRODUCTS_NOT_SUPPORTED error if called on an Item that contains only non-depository accounts from that institution.

As this endpoint triggers a synchronous request for fresh data, latency may be higher than for other Plaid endpoints (typically less than 10 seconds, but occasionally up to 30 seconds or more); if you encounter errors, you may find it necessary to adjust your timeout period when making requests.

/processor/transactions/refresh is offered as an add-on to Transactions and has a separate fee model. To request access to this endpoint, submit a product access request or contact your Plaid account manager.

Request Body

Required

ProcessorTransactionsRefreshRequest defines the request schema for /processor/transactions/refresh

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.
processor_token
required, string
The processor token obtained from the Plaid integration partner. Processor tokens are in the format: processor-<environment>-<identifier>
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.

Response

ProcessorTransactionsRefreshResponse defines the response schema for /processor/transactions/refresh

Response Properties

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.