9.2 KiB
9.2 KiB
name, description
| name | description |
|---|---|
| transfer-routes | Handle 42 OpenAPI operation(s) under /transfer for the transfer route group. |
transfer API Routes
Handle 42 OpenAPI operation(s) under /transfer for the transfer route group.
Use the generated operation tools to make real API calls. Do not invent API responses. If a tool reports missing setup, return the exact setup field name to the caller. For write, update, or delete operations, state the intended action before calling the tool.
Operations
transfer_get
- Operation ID:
transfer_get - Route:
POST /transfer/get - Mode: WRITE
- Summary: Retrieve a transfer
- Body: JSON request body accepted.
transfer_recurring_get
- Operation ID:
transfer_recurring_get - Route:
POST /transfer/recurring/get - Mode: WRITE
- Summary: Retrieve a recurring transfer
- Body: JSON request body accepted.
transfer_authorization_create
- Operation ID:
transfer_authorization_create - Route:
POST /transfer/authorization/create - Mode: WRITE
- Summary: Create a transfer authorization
- Body: JSON request body accepted.
transfer_authorization_cancel
- Operation ID:
transfer_authorization_cancel - Route:
POST /transfer/authorization/cancel - Mode: WRITE
- Summary: Cancel a transfer authorization
- Body: JSON request body accepted.
transfer_balance_get
- Operation ID:
transfer_balance_get - Route:
POST /transfer/balance/get - Mode: WRITE
- Summary: (Deprecated) Retrieve a balance held with Plaid
- Body: JSON request body accepted.
transfer_capabilities_get
- Operation ID:
transfer_capabilities_get - Route:
POST /transfer/capabilities/get - Mode: WRITE
- Summary: Get RTP eligibility information of a transfer
- Body: JSON request body accepted.
transfer_configuration_get
- Operation ID:
transfer_configuration_get - Route:
POST /transfer/configuration/get - Mode: WRITE
- Summary: Get transfer product configuration
- Body: JSON request body accepted.
transfer_ledger_get
- Operation ID:
transfer_ledger_get - Route:
POST /transfer/ledger/get - Mode: WRITE
- Summary: Retrieve Plaid Ledger balance
- Body: JSON request body accepted.
transfer_ledger_distribute
- Operation ID:
transfer_ledger_distribute - Route:
POST /transfer/ledger/distribute - Mode: WRITE
- Summary: Move available balance between ledgers
- Body: JSON request body accepted.
transfer_ledger_deposit
- Operation ID:
transfer_ledger_deposit - Route:
POST /transfer/ledger/deposit - Mode: WRITE
- Summary: Deposit funds into a Plaid Ledger balance
- Body: JSON request body accepted.
transfer_ledger_withdraw
- Operation ID:
transfer_ledger_withdraw - Route:
POST /transfer/ledger/withdraw - Mode: WRITE
- Summary: Withdraw funds from a Plaid Ledger balance
- Body: JSON request body accepted.
transfer_originator_funding_account_update
- Operation ID:
transfer_originator_funding_account_update - Route:
POST /transfer/originator/funding_account/update - Mode: WRITE
- Summary: Update the funding account associated with the originator
- Body: JSON request body accepted.
transfer_originator_funding_account_create
- Operation ID:
transfer_originator_funding_account_create - Route:
POST /transfer/originator/funding_account/create - Mode: WRITE
- Summary: Create a new funding account for an originator
- Body: JSON request body accepted.
transfer_metrics_get
- Operation ID:
transfer_metrics_get - Route:
POST /transfer/metrics/get - Mode: WRITE
- Summary: Get transfer product usage metrics
- Body: JSON request body accepted.
transfer_create
- Operation ID:
transfer_create - Route:
POST /transfer/create - Mode: WRITE
- Summary: Create a transfer
- Body: JSON request body accepted.
transfer_recurring_create
- Operation ID:
transfer_recurring_create - Route:
POST /transfer/recurring/create - Mode: WRITE
- Summary: Create a recurring transfer
- Body: JSON request body accepted.
transfer_list
- Operation ID:
transfer_list - Route:
POST /transfer/list - Mode: WRITE
- Summary: List transfers
- Body: JSON request body accepted.
transfer_recurring_list
- Operation ID:
transfer_recurring_list - Route:
POST /transfer/recurring/list - Mode: WRITE
- Summary: List recurring transfers
- Body: JSON request body accepted.
transfer_cancel
- Operation ID:
transfer_cancel - Route:
POST /transfer/cancel - Mode: WRITE
- Summary: Cancel a transfer
- Body: JSON request body accepted.
transfer_recurring_cancel
- Operation ID:
transfer_recurring_cancel - Route:
POST /transfer/recurring/cancel - Mode: WRITE
- Summary: Cancel a recurring transfer.
- Body: JSON request body accepted.
transfer_event_list
- Operation ID:
transfer_event_list - Route:
POST /transfer/event/list - Mode: WRITE
- Summary: List transfer events
- Body: JSON request body accepted.
transfer_ledger_event_list
- Operation ID:
transfer_ledger_event_list - Route:
POST /transfer/ledger/event/list - Mode: WRITE
- Summary: List transfer ledger events
- Body: JSON request body accepted.
transfer_event_sync
- Operation ID:
transfer_event_sync - Route:
POST /transfer/event/sync - Mode: WRITE
- Summary: Sync transfer events
- Body: JSON request body accepted.
transfer_sweep_get
- Operation ID:
transfer_sweep_get - Route:
POST /transfer/sweep/get - Mode: WRITE
- Summary: Retrieve a sweep
- Body: JSON request body accepted.
transfer_sweep_list
- Operation ID:
transfer_sweep_list - Route:
POST /transfer/sweep/list - Mode: WRITE
- Summary: List sweeps
- Body: JSON request body accepted.
transfer_migrate_account
- Operation ID:
transfer_migrate_account - Route:
POST /transfer/migrate_account - Mode: WRITE
- Summary: Migrate account into Transfers
- Body: JSON request body accepted.
transfer_intent_create
- Operation ID:
transfer_intent_create - Route:
POST /transfer/intent/create - Mode: WRITE
- Summary: Create a transfer intent object to invoke the Transfer UI
- Body: JSON request body accepted.
transfer_intent_get
- Operation ID:
transfer_intent_get - Route:
POST /transfer/intent/get - Mode: WRITE
- Summary: Retrieve more information about a transfer intent
- Body: JSON request body accepted.
transfer_repayment_list
- Operation ID:
transfer_repayment_list - Route:
POST /transfer/repayment/list - Mode: WRITE
- Summary: Lists historical repayments
- Body: JSON request body accepted.
transfer_repayment_return_list
- Operation ID:
transfer_repayment_return_list - Route:
POST /transfer/repayment/return/list - Mode: WRITE
- Summary: List the returns included in a repayment
- Body: JSON request body accepted.
transfer_platform_requirement_submit
- Operation ID:
transfer_platform_requirement_submit - Route:
POST /transfer/platform/requirement/submit - Mode: WRITE
- Summary: Submit additional onboarding information on behalf of an originator
- Body: JSON request body accepted.
transfer_originator_create
- Operation ID:
transfer_originator_create - Route:
POST /transfer/originator/create - Mode: WRITE
- Summary: Create a new originator
- Body: JSON request body accepted.
transfer_questionnaire_create
- Operation ID:
transfer_questionnaire_create - Route:
POST /transfer/questionnaire/create - Mode: WRITE
- Summary: Generate a Plaid-hosted onboarding UI URL.
- Body: JSON request body accepted.
transfer_diligence_submit
- Operation ID:
transfer_diligence_submit - Route:
POST /transfer/diligence/submit - Mode: WRITE
- Summary: Submit transfer diligence on behalf of the originator
- Body: JSON request body accepted.
transfer_diligence_document_upload
- Operation ID:
transfer_diligence_document_upload - Route:
POST /transfer/diligence/document/upload - Mode: WRITE
- Summary: Upload transfer diligence document on behalf of the originator
- Body: JSON request body accepted.
transfer_originator_get
- Operation ID:
transfer_originator_get - Route:
POST /transfer/originator/get - Mode: WRITE
- Summary: Get status of an originator's onboarding
- Body: JSON request body accepted.
transfer_originator_list
- Operation ID:
transfer_originator_list - Route:
POST /transfer/originator/list - Mode: WRITE
- Summary: Get status of all originators' onboarding
- Body: JSON request body accepted.
transfer_refund_create
- Operation ID:
transfer_refund_create - Route:
POST /transfer/refund/create - Mode: WRITE
- Summary: Create a refund
- Body: JSON request body accepted.
transfer_refund_get
- Operation ID:
transfer_refund_get - Route:
POST /transfer/refund/get - Mode: WRITE
- Summary: Retrieve a refund
- Body: JSON request body accepted.
transfer_refund_cancel
- Operation ID:
transfer_refund_cancel - Route:
POST /transfer/refund/cancel - Mode: WRITE
- Summary: Cancel a refund
- Body: JSON request body accepted.
transfer_platform_originator_create
- Operation ID:
transfer_platform_originator_create - Route:
POST /transfer/platform/originator/create - Mode: WRITE
- Summary: Create an originator for Transfer for Platforms customers
- Body: JSON request body accepted.
transfer_platform_person_create
- Operation ID:
transfer_platform_person_create - Route:
POST /transfer/platform/person/create - Mode: WRITE
- Summary: Create a person associated with an originator
- Body: JSON request body accepted.