plaid

Retrieve a transfer

Changed on

The /transfer/get endpoint fetches information about the transfer corresponding to the given transfer_id or authorization_id. One of transfer_id or authorization_id must be populated but not both.

post/transfer/get

Request

  • Base URL
    https://production.plaid.com
  • URL
    https://production.plaid.com/transfer/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.

transfer_idstring

Plaid's unique identifier for a transfer.

authorization_idstring

Plaid's unique identifier for a transfer authorization.

originator_client_idstring nullable

The Plaid client ID of the transfer originator. Should only be present if client_id is a third-party sender (TPS).

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.

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

    • info

      response property transfer/credit_funds_source/allOf[subschema #1: TransferCreditFundsSource]/ deprecated