plaid

Get transfer product usage metrics

Changed on

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

Request

  • Base URL
    https://production.plaid.com
  • URL
    https://production.plaid.com/transfer/metrics/get
  • Auth
    API key in header PLAID-CLIENT-ID and API key in header PLAID-SECRET and API key in header Plaid-Version

Request body

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.

Response

OK

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 created so far in the current day, Eastern Time (decimal string with two digits of precision e.g. "10.00").

daily_credit_transfer_volumestring required

Sum of dollar amount of credit transfers created so far in the current day, Eastern Time (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".

Changes

  • ea443cd78f6fRevision changes
    • warning

      added the new CRA_PARTNER_INSIGHTS_ERROR enum value to the response property for the response status

    • warning

      added the new CRA_REPORT_ERROR enum value to the response property for the response status

  • a1bbca018160Revision changes
    • warning

      added the new ASSETS_ERROR enum value to the response property for the response status

    • warning

      added the new CRA_MONITORING_ERROR enum value to the response property for the response status

    • warning

      added the new CREDIT_PROFILE_REPORT_ERROR enum value to the response property for the response status

    • warning

      added the new ENCOMPASS_ERROR enum value to the response property for the response status

    • warning

      added the new ENRICH_ERROR enum value to the response property for the response status

    • warning

      added the new FRAUD_INSIGHTS_ERROR enum value to the response property for the response status

    • warning

      added the new FREDDIE_MAC_ERROR enum value to the response property for the response status

    • warning

      added the new LINK_DELIVERY_ERROR enum value to the response property for the response status

    • warning

      added the new PROFILE_ERROR enum value to the response property for the response status

    • warning

      added the new RECURRING_TRANSACTIONS_ERROR enum value to the response property for the response status

    • warning

      added the new STATEMENTS_ERROR enum value to the response property for the response status

    • warning

      added the new TRANSFER_RECURRING_ERROR enum value to the response property for the response status

    • warning

      added the new TRANSFER_REFUND_ERROR enum value to the response property for the response status