Get transfer product usage metrics

POST /transfer/metrics/get

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

Request Body

Required

Defines the request schema for /transfer/metrics/get

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.
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.

Response

Defines the response schema for /transfer/metrics/get

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.
daily_debit_transfer_volume
required, 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
required, string
Sum of dollar amount of credit transfers in last 24 hours (decimal string with two digits of precision e.g. “10.00”).
monthly_transfer_volume
required, string
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_volume
required, 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
required, 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
required, string
The currency of the dollar amount, e.g. “USD”.
return_rates
object
Details regarding return rates.
last_60d
object
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
object
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.