Plaid logo
Docs
ALL DOCS

API

  • Overview
  • Libraries
  • API versioning
  • Postman Collection
  • Webhooks
Payments and Funding
  • Auth
  • Balance
  • Identity
  • Signal
  • Transfer
    • Initiating Transfers
    • Reading Transfers
    • Account Linking
    • Recurring Transfers
    • Refunds
    • Platform Payments
    • Plaid Ledger
    • Program Metrics
    • Sandbox
  • Investments Move
  • Payment Initiation
  • Virtual Accounts
Financial Insights
  • Transactions
  • Investments
  • Liabilities
  • Enrich
KYC/AML and anti-fraud
  • Look up Dashboard users
  • Identity Verification
  • Monitor
  • Beacon (beta)
Instant Onboarding
  • Layer
Credit and Underwriting
  • Consumer Report (by Plaid Check)
  • Assets
  • Statements
  • Income
Fundamentals
  • Items
  • Accounts
  • Institutions
  • Sandbox
  • Link
  • Users
  • Consent
  • Network
  • OAuth
Partnerships
  • Processor tokens
  • Processor partners
  • Reseller partners
Plaid logo
Docs
Close search modal
Ask Bill!
Ask Bill!
Hi! I'm Bill! You can ask me all about the Plaid API. Try asking questions like:
  • What's the difference between an Item and an access token?
  • Can you show code for getting real-time balance in Node?
  • How do I set up a webhook for IDV?
Note: Bill isn't perfect. He's just a robot platypus that reads our docs for fun. You should treat his answers with the same healthy skepticism you might treat any other answer on the internet. This chat may be logged for quality and training purposes. Please don't send Bill any PII -- he's scared of intimacy. All chats with Bill are subject to Plaid's Privacy Policy.
Plaid.com
Log in
Get API Keys
Open nav

Program Metrics

API reference for Transfer program metrics

For how-to guidance, see the Transfer documentation.

Program Metrics
/transfer/metrics/getGet transfer product usage metrics
/transfer/configuration/getGet transfer product configuration

/transfer/metrics/get

Get transfer product usage metrics

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

transfer/metrics/get

Request fields

client_id
stringstring
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
stringstring
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_id
stringstring
The Plaid client ID of the transfer originator. Should only be present if client_id is a Platform customer.
Select Language
1const request: TransferMetricsGetRequest = {
2 originator_client_id: '61b8f48ded273e001aa8db6d',
3};
4
5try {
6 const response = await client.transferMetricsGet(request);
7} catch (error) {
8 // handle error
9}
transfer/metrics/get

Response fields and example

request_id
stringstring
A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
daily_debit_transfer_volume
stringstring
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_volume
stringstring
Sum of dollar amount of credit transfers in last 24 hours (decimal string with two digits of precision e.g. "10.00").
monthly_debit_transfer_volume
stringstring
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_volume
stringstring
Sum of dollar amount of credit transfers in current calendar month (decimal string with two digits of precision e.g. "10.00").
iso_currency_code
stringstring
The currency of the dollar amount, e.g. "USD".
return_rates
nullableobjectnullable, object
Details regarding return rates.
last_60d
nullableobjectnullable, object
Details regarding return rates.
overall_return_rate
stringstring
The overall return rate.
unauthorized_return_rate
stringstring
The unauthorized return rate.
administrative_return_rate
stringstring
The administrative return rate.
authorization_usage
nullableobjectnullable, object
Details regarding authorization usage.
daily_credit_utilization
stringstring
The daily credit utilization formatted as a decimal.
daily_debit_utilization
stringstring
The daily debit utilization formatted as a decimal.
monthly_credit_utilization
stringstring
The monthly credit utilization formatted as a decimal.
monthly_debit_utilization
stringstring
The monthly debit utilization formatted as a decimal.
1{
2 "daily_debit_transfer_volume": "1234.56",
3 "daily_credit_transfer_volume": "567.89",
4 "monthly_transfer_volume": "",
5 "monthly_debit_transfer_volume": "10000.00",
6 "monthly_credit_transfer_volume": "2345.67",
7 "iso_currency_code": "USD",
8 "request_id": "saKrIBuEB9qJZno",
9 "return_rates": {
10 "last_60d": {
11 "overall_return_rate": "0.1023",
12 "administrative_return_rate": "0.0160",
13 "unauthorized_return_rate": "0.0028"
14 }
15 },
16 "authorization_usage": {
17 "daily_credit_utilization": "0.2300",
18 "daily_debit_utilization": "0.3401",
19 "monthly_credit_utilization": "0.9843",
20 "monthly_debit_utilization": "0.3220"
21 }
22}
Was this helpful?

/transfer/configuration/get

Get transfer product configuration

Use the /transfer/configuration/get endpoint to view your transfer product configurations.

transfer/configuration/get

Request fields

client_id
stringstring
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
stringstring
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_id
stringstring
The Plaid client ID of the transfer originator. Should only be present if client_id is a Platform customer.
Select Language
1const request: TransferConfigurationGetRequest = {
2 originator_client_id: '61b8f48ded273e001aa8db6d',
3};
4
5try {
6 const response = await client.transferConfigurationGet(request);
7} catch (error) {
8 // handle error
9}
transfer/configuration/get

Response fields and example

request_id
stringstring
A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
max_single_transfer_credit_amount
stringstring
The max limit of dollar amount of a single credit transfer (decimal string with two digits of precision e.g. "10.00").
max_single_transfer_debit_amount
stringstring
The max limit of dollar amount of a single debit transfer (decimal string with two digits of precision e.g. "10.00").
max_daily_credit_amount
stringstring
The max limit of sum of dollar amount of credit transfers in last 24 hours (decimal string with two digits of precision e.g. "10.00").
max_daily_debit_amount
stringstring
The max limit of sum of dollar amount of debit transfers in last 24 hours (decimal string with two digits of precision e.g. "10.00").
max_monthly_credit_amount
stringstring
The max limit of sum of dollar amount of credit transfers in one calendar month (decimal string with two digits of precision e.g. "10.00").
max_monthly_debit_amount
stringstring
The max limit of sum of dollar amount of debit transfers in one calendar month (decimal string with two digits of precision e.g. "10.00").
iso_currency_code
stringstring
The currency of the dollar amount, e.g. "USD".
1{
2 "max_single_transfer_amount": "",
3 "max_single_transfer_credit_amount": "1000.00",
4 "max_single_transfer_debit_amount": "1000.00",
5 "max_daily_credit_amount": "50000.00",
6 "max_daily_debit_amount": "50000.00",
7 "max_monthly_amount": "",
8 "max_monthly_credit_amount": "500000.00",
9 "max_monthly_debit_amount": "500000.00",
10 "iso_currency_code": "USD",
11 "request_id": "saKrIBuEB9qJZno"
12}
Was this helpful?
Developer community
GitHub
GitHub
Stack Overflow
Stack Overflow
YouTube
YouTube
Discord
Discord