---
title: "Retrieve a recurring transfer"
method: POST
path: "/transfer/recurring/get"
tags: ["plaid"]
---

# Retrieve a recurring transfer

`POST /transfer/recurring/get`

The `/transfer/recurring/get` fetches information about the recurring transfer corresponding to the given `recurring_transfer_id`.

## Request body

- TransferRecurringGetRequest — Defines the request schema for `/transfer/recurring/get`
  - `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.
  - `recurring_transfer_id` string, required — Plaid’s unique identifier for a recurring transfer.

## Response `200`

OK

- TransferRecurringGetResponse — Defines the response schema for `/transfer/recurring/get`
  - `recurring_transfer` RecurringTransfer, required — Represents a recurring transfer within the Transfers API.
    - `recurring_transfer_id` string, required — Plaid’s unique identifier for a recurring transfer.
    - `created` string, date-time, required — The datetime when this transfer was created. This will be of the form `2006-01-02T15:04:05Z`
    - `next_origination_date` string, date, nullable, required — A date in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD). The next transfer origination date after bank holiday adjustment.
    - `test_clock_id` string, nullable — Plaid’s unique identifier for a test clock.
    - `type` 'debit' | 'credit', required — The type of transfer. This will be either `debit` or `credit`. A `debit` indicates a transfer of money into the origination account; a `credit` indicates a transfer of money out of the origination account.
    - `amount` string, required — The amount of the transfer (decimal string with two digits of precision e.g. "10.00"). When calling `/transfer/authorization/create`, specify the maximum amount to authorize. When calling `/transfer/create`, specify the exact amount of the transfer, up to a maximum of the amount authorized. If this field is left blank when calling `/transfer/create`, the maximum amount authorized in the `authorization_id` will be sent.
    - `status` 'active' | 'cancelled' | 'expired', required — The status of the recurring transfer. `active`: The recurring transfer is currently active. `cancelled`: The recurring transfer was cancelled by the client or Plaid. `expired`: The recurring transfer has completed all originations according to its recurring schedule.
    - `ach_class` 'ccd' | 'ppd' | 'tel' | 'web' — Specifies the use case of the transfer. Required for transfers on an ACH network. Codes supported for credits: `ccd`, `ppd` Codes supported for debits: `ccd`, `tel`, `web` `"ccd"` - Corporate Credit or Debit - fund transfer between two corporate bank accounts `"ppd"` - Prearranged Payment or Deposit - the transfer is part of a pre-existing relationship with a consumer, e.g. bill payment `"tel"` - Telephone-Initiated Entry `"web"` - Internet-Initiated Entry - debits from a consumer’s account where their authorization is obtained over the Internet
    - `network` 'ach' | 'same-day-ach' | 'rtp', required — Networks eligible for recurring transfers.
    - `origination_account_id` string, required — Plaid’s unique identifier for the origination account that was used for this transfer.
    - `account_id` string, required — The Plaid `account_id` corresponding to the end-user account that will be debited or credited.
    - `funding_account_id` string, required — The id of the funding account to use, available in the Plaid Dashboard. This determines which of your business checking accounts will be credited or debited.
    - `iso_currency_code` string, required — The currency of the transfer amount, e.g. "USD"
    - `description` string, required — The description of the recurring transfer.
    - `transfer_ids` TransferID[], required
    - `user` TransferUserInResponse, required — The legal name and other information for the account holder.
      - `legal_name` string, required — The user's legal name.
      - `phone_number` string, nullable, required — The user's phone number.
      - `email_address` string, nullable, required — The user's email address.
      - `address` TransferUserAddressInResponse, nullable, required — The address associated with the account holder.
        - `street` string, nullable, required — The street number and name (i.e., "100 Market St.").
        - `city` string, nullable, required — Ex. "San Francisco"
        - `region` string, nullable, required — The state or province (e.g., "CA").
        - `postal_code` string, nullable, required — The postal code (e.g., "94103").
        - `country` string, nullable, required — A two-letter country code (e.g., "US").
    - `schedule` TransferRecurringSchedule, required — The schedule that the recurring transfer will be executed on.
      - `interval_unit` 'week' | 'month', required — The unit of the recurring interval.
      - `interval_count` integer, required — The number of recurring `interval_units` between originations. The recurring interval (before holiday adjustment) is calculated by multiplying `interval_unit` and `interval_count`. For example, to schedule a recurring transfer which originates once every two weeks, set `interval_unit` = `week` and `interval_count` = 2.
      - `interval_execution_day` integer, required — The day of the interval on which to schedule the transfer. If the `interval_unit` is `week`, `interval_execution_day` should be an integer from 1 (Monday) to 5 (Friday). If the `interval_unit` is `month`, `interval_execution_day` should be an integer indicating which day of the month to make the transfer on. Integers from 1 to 28 can be used to make a transfer on that day of the month. Negative integers from -1 to -5 can be used to make a transfer relative to the end of the month. To make a transfer on the last day of the month, use -1; to make the transfer on the second-to-last day, use -2, and so on. The transfer will be originated on the next available banking day if the designated day is a non banking day.
      - `start_date` string, date, required — A date in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD). The recurring transfer will begin on the first `interval_execution_day` on or after the `start_date`. For `rtp` recurring transfers, `start_date` must be in the future. Otherwise, if the first `interval_execution_day` on or after the start date is also the same day that `/transfer/recurring/create` was called, the bank *may* make the first payment on that day, but it is not guaranteed to do so.
      - `end_date` string, date, nullable — A date in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD). The recurring transfer will end on the last `interval_execution_day` on or before the `end_date`. If the `interval_execution_day` between the start date and the end date (inclusive) is also the same day that `/transfer/recurring/create` was called, the bank *may* make a payment on that day, but it is not guaranteed to do so.
  - `request_id` string, required — A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.

## Other responses

- `default` — Error response

## Changes

- **2024-04-17** `943c632a075c` — 1 warning
  - added the new `rtp` enum value to the `recurring_transfer/network` response property for the response status `200`
- **2024-03-21** `5594c3a3f55a` — 2 info
  - removed the `rtp` enum value from the `recurring_transfer/network` response property for the response status `200`
  - removed the `wire` enum value from the `recurring_transfer/network` response property for the response status `200`
- **2024-02-21** `5de70cc1e6ca` — 4 warning, 11 info
  - removed the optional property `error_code_reason` from the response with the `default` status
  - removed the optional property `provided_account_subtypes` from the response with the `default` status
  - removed the optional property `required_account_subtypes` from the response with the `default` status
  - added the new `wire` enum value to the `recurring_transfer/network` response property for the response status `200`
  - …11 more

[Change history](https://skmtc.dev/plaid/apis/the-plaid-api/changes/transfer/recurring/get/post.md)

---

[API](https://skmtc.dev/plaid/apis/the-plaid-api.md) · [All operations](https://skmtc.dev/plaid/apis/the-plaid-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/plaid/the-plaid-api/revisions/a5b45bccb4e8/schema)