v51

latestOpenAPI 3.0.0raw.githubusercontent.com2026-07-313352,3122.9 MB

plaid

Get transfer product usage metrics

Use the /transfer/metrics/get endpoint to view your transfer product usage metrics.

In the Sandbox environment, this endpoint returns static placeholder values rather than metrics computed from your Sandbox transfer activity.

post/transfer/metrics/get

client_idstring

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.

secretstring

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.

originator_client_idstring nullable

The Plaid client ID of the transfer originator. Should only be present if client_id is a Platform customer.

request_idstring required

A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.

daily_debit_transfer_volumestring required

Sum of dollar amount of debit transfers in last 24 hours (decimal string with two digits of precision e.g. "10.00").

daily_credit_transfer_volumestring required

Sum of dollar amount of credit transfers in last 24 hours (decimal string with two digits of precision e.g. "10.00").

monthly_transfer_volumestring required

Sum of dollar amount of credit and debit transfers in current calendar month (decimal string with two digits of precision e.g. "10.00").

monthly_debit_transfer_volumestring required

Sum of dollar amount of debit transfers in current calendar month (decimal string with two digits of precision e.g. "10.00").

monthly_credit_transfer_volumestring required

Sum of dollar amount of credit transfers in current calendar month (decimal string with two digits of precision e.g. "10.00").

iso_currency_codestring required

The currency of the dollar amount, e.g. "USD".