Transfer

API reference for Transfer endpoints and webhooks

Transfer endpoints are only supported in Plaid's Sandbox and Production environments.

Initiating Transfers
`/transfer/authorization/create`	Create a transfer authorization
`/transfer/create`	Create a transfer
`/transfer/cancel`	Cancel a transfer

Reading Transfers
`/transfer/get`	Retrieve information about a transfer
`/transfer/list`	Retrieve a list of transfers and their statuses
`/transfer/event/list`	Retrieve a list of transfer events
`/transfer/event/sync`	Sync transfer events
`/transfer/sweep/get`	Retrieve information about a sweep
`/transfer/sweep/list`	Retrieve a list of sweeps

Account Linking
`/transfer/capabilities/get`	Determine RTP eligibility for a Plaid Item
`/transfer/intent/create`	Create a transfer intent and invoke Transfer UI (Transfer UI only)
`/transfer/intent/get`	Retrieve information about a transfer intent (Transfer UI only)
`/transfer/migrate_account`	Create an Item to use with Transfer from known account and routing numbers

Recurring Transfers
`/transfer/recurring/create`	Create a recurring transfer
`/transfer/recurring/cancel`	Cancel a recurring transfer
`/transfer/recurring/get`	Retrieve information about a recurring transfer
`/transfer/recurring/list`	Retrieve a list of recurring transfers

Refunds
`/transfer/refund/create`	Create a refund for a transfer
`/transfer/refund/cancel`	Cancel a refund
`/transfer/refund/get`	Retrieve information about a refund

Platform Payments
`/transfer/originator/create`	Create a new originator
`/transfer/originator/get`	Get the status of an originator's onboarding
`/transfer/originator/list`	Get the status of all originators' onboarding
`/transfer/originator/funding_account/update`	Update the default funding account of an originator
`/transfer/questionnaire/create`	Generate a Plaid-hosted onboarding UI URL
`/transfer/diligence/submit`	Submit transfer diligence on behalf of the originator
`/transfer/diligence/document/upload`	Upload transfer diligence document on behalf of the originator

Plaid Ledger
`/transfer/ledger/deposit`	Deposit funds into a ledger balance held with Plaid
`/transfer/ledger/distribute`	Move available balance between platform and its originator
`/transfer/ledger/get`	Retrieve information about the ledger balance held with Plaid
`/transfer/ledger/withdraw`	Withdraw funds from a ledger balance held with Plaid

Program Metrics
`/transfer/metrics/get`	Get transfer product usage metrics
`/transfer/configuration/get`	Get transfer product configuration

Balances
`/transfer/balance/get`	Retrieve information about a balance held with Plaid

Sandbox
`/sandbox/transfer/simulate`	Simulate a transfer event
`/sandbox/transfer/refund/simulate`	Simulate a refund event
`/sandbox/transfer/sweep/simulate`	Simulate creating a sweep
`/sandbox/transfer/fire_webhook`	Simulate a transfer webhook
`/sandbox/transfer/ledger/deposit/simulate`	Simulate a deposit sweep event
`/sandbox/transfer/ledger/simulate_available`	Simulate converting pending balance into available balance
`/sandbox/transfer/ledger/withdraw/simulate`	Simulate a withdrawal sweep event
`/sandbox/transfer/test_clock/create`	Create a test clock
`/sandbox/transfer/test_clock/advance`	Advance a test clock
`/sandbox/transfer/test_clock/get`	Retrieve information about a test clock
`/sandbox/transfer/test_clock/list`	Retrieve a list of test clocks

Webhooks
`TRANSFER_EVENTS_UPDATE`	New transfer events available
`RECURRING_CANCELLED`	A recurring transfer has been cancelled by Plaid
`RECURRING_NEW_TRANSFER`	A new transfer of a recurring transfer has been originated
`RECURRING_TRANSFER_SKIPPED`	An instance of a scheduled recurring transfer could not be created