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
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.
originator_client_id
string
The Plaid client ID of the transfer originator. Should only be present if client_id is a Platform customer.
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
string
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
string
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
string
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
string
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
string
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
string
The currency of the dollar amount, e.g. "USD".
return_rates
nullableobject
Details regarding return rates.
last_60d
nullableobject
Details regarding return rates.
overall_return_rate
string
The overall return rate.
unauthorized_return_rate
string
The unauthorized return rate.
administrative_return_rate
string
The administrative return rate.
authorization_usage
nullableobject
Details regarding authorization usage.
daily_credit_utilization
string
The daily credit utilization formatted as a decimal.
daily_debit_utilization
string
The daily debit utilization formatted as a decimal.
monthly_credit_utilization
string
The monthly credit utilization formatted as a decimal.
monthly_debit_utilization
string
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}

/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
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.
originator_client_id
string
The Plaid client ID of the transfer originator. Should only be present if client_id is a Platform customer.
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
string
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
string
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
string
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
string
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
string
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
string
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
string
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
string
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}