Program Metrics
API reference for Transfer program metrics
For how-to guidance, see the Transfer documentation.
| Program Metrics | |
|---|---|
/transfer/metrics/get | Get transfer product usage metrics |
/transfer/configuration/get | Get transfer product configuration |
/transfer/metrics/get
Get transfer product usage metrics
Use the /transfer/metrics/get endpoint to view your transfer product usage metrics.
Request fields
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
The Plaid client ID of the transfer originator. Should only be present if
client_id is a Platform customer./transfer/metrics/get
const request: TransferMetricsGetRequest = {
originator_client_id: '61b8f48ded273e001aa8db6d',
};
try {
const response = await client.transferMetricsGet(request);
} catch (error) {
// handle error
}
Response fields
request_idstring
A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
daily_debit_transferstring
Sum of dollar amount of debit transfers in last 24 hours (decimal string with two digits of precision e.g. "10.00").
daily_credit_transferstring
Sum of dollar amount of credit transfers in last 24 hours (decimal string with two digits of precision e.g. "10.00").
monthly_debitstring
Sum of dollar amount of debit transfers in current calendar month (decimal string with two digits of precision e.g. "10.00").
monthly_creditstring
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
The currency of the dollar amount, e.g. "USD".
return_ratesnullableobject
Details regarding return rates.
last_60dnullableobject
Details regarding return rates.
overall_return_ratestring
The overall return rate.
unauthorized_returnstring
The unauthorized return rate.
administrative_returnstring
The administrative return rate.
authorization_usagenullableobject
Details regarding authorization usage.
daily_creditstring
The daily credit utilization formatted as a decimal.
daily_debitstring
The daily debit utilization formatted as a decimal.
monthly_creditstring
The monthly credit utilization formatted as a decimal.
monthly_debitstring
The monthly debit utilization formatted as a decimal.
Response Object
{
"daily_debit_transfer_volume": "1234.56",
"daily_credit_transfer_volume": "567.89",
"monthly_transfer_volume": "",
"monthly_debit_transfer_volume": "10000.00",
"monthly_credit_transfer_volume": "2345.67",
"iso_currency_code": "USD",
"request_id": "saKrIBuEB9qJZno",
"return_rates": {
"last_60d": {
"overall_return_rate": "0.1023",
"administrative_return_rate": "0.0160",
"unauthorized_return_rate": "0.0028"
}
},
"authorization_usage": {
"daily_credit_utilization": "0.2300",
"daily_debit_utilization": "0.3401",
"monthly_credit_utilization": "0.9843",
"monthly_debit_utilization": "0.3220"
}
}/transfer/configuration/get
Get transfer product configuration
Use the /transfer/configuration/get endpoint to view your transfer product configurations.
Request fields
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
The Plaid client ID of the transfer originator. Should only be present if
client_id is a Platform customer./transfer/configuration/get
const request: TransferConfigurationGetRequest = {
originator_client_id: '61b8f48ded273e001aa8db6d',
};
try {
const response = await client.transferConfigurationGet(request);
} catch (error) {
// handle error
}
Response fields
request_idstring
A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
max_single_transferstring
The max limit of dollar amount of a single credit transfer (decimal string with two digits of precision e.g. "10.00").
max_single_transferstring
The max limit of dollar amount of a single debit transfer (decimal string with two digits of precision e.g. "10.00").
max_daily_creditstring
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_amountstring
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_creditstring
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_debitstring
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_codestring
The currency of the dollar amount, e.g. "USD".
Response Object
{
"max_single_transfer_amount": "",
"max_single_transfer_credit_amount": "1000.00",
"max_single_transfer_debit_amount": "1000.00",
"max_daily_credit_amount": "50000.00",
"max_daily_debit_amount": "50000.00",
"max_monthly_amount": "",
"max_monthly_credit_amount": "500000.00",
"max_monthly_debit_amount": "500000.00",
"iso_currency_code": "USD",
"request_id": "saKrIBuEB9qJZno"
}