207 lines
5.8 KiB
Markdown
207 lines
5.8 KiB
Markdown
---
|
|
name: processor-routes
|
|
description: Handle 24 OpenAPI operation(s) under /processor for the processor route group.
|
|
---
|
|
|
|
# processor API Routes
|
|
|
|
Handle 24 OpenAPI operation(s) under /processor for the processor 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
|
|
|
|
### processor_auth_get
|
|
|
|
- Operation ID: `processor_auth_get`
|
|
- Route: `POST /processor/auth/get`
|
|
- Mode: WRITE
|
|
- Summary: Retrieve Auth data
|
|
- Body: JSON request body accepted.
|
|
|
|
### processor_account_get
|
|
|
|
- Operation ID: `processor_account_get`
|
|
- Route: `POST /processor/account/get`
|
|
- Mode: WRITE
|
|
- Summary: Retrieve the account associated with a processor token
|
|
- Body: JSON request body accepted.
|
|
|
|
### processor_investments_holdings_get
|
|
|
|
- Operation ID: `processor_investments_holdings_get`
|
|
- Route: `POST /processor/investments/holdings/get`
|
|
- Mode: WRITE
|
|
- Summary: Retrieve Investment Holdings
|
|
- Body: JSON request body accepted.
|
|
|
|
### processor_investments_auth_get
|
|
|
|
- Operation ID: `processor_investments_auth_get`
|
|
- Route: `POST /processor/investments/auth/get`
|
|
- Mode: WRITE
|
|
- Summary: Get investment account authentication data
|
|
- Body: JSON request body accepted.
|
|
|
|
### processor_investments_transactions_get
|
|
|
|
- Operation ID: `processor_investments_transactions_get`
|
|
- Route: `POST /processor/investments/transactions/get`
|
|
- Mode: WRITE
|
|
- Summary: Get investment transactions data
|
|
- Body: JSON request body accepted.
|
|
|
|
### processor_transactions_get
|
|
|
|
- Operation ID: `processor_transactions_get`
|
|
- Route: `POST /processor/transactions/get`
|
|
- Mode: WRITE
|
|
- Summary: Get transaction data
|
|
- Body: JSON request body accepted.
|
|
|
|
### processor_transactions_sync
|
|
|
|
- Operation ID: `processor_transactions_sync`
|
|
- Route: `POST /processor/transactions/sync`
|
|
- Mode: WRITE
|
|
- Summary: Get incremental transaction updates on a processor token
|
|
- Body: JSON request body accepted.
|
|
|
|
### processor_transactions_refresh
|
|
|
|
- Operation ID: `processor_transactions_refresh`
|
|
- Route: `POST /processor/transactions/refresh`
|
|
- Mode: WRITE
|
|
- Summary: Refresh transaction data
|
|
- Body: JSON request body accepted.
|
|
|
|
### processor_transactions_recurring_get
|
|
|
|
- Operation ID: `processor_transactions_recurring_get`
|
|
- Route: `POST /processor/transactions/recurring/get`
|
|
- Mode: WRITE
|
|
- Summary: Fetch recurring transaction streams
|
|
- Body: JSON request body accepted.
|
|
|
|
### processor_signal_evaluate
|
|
|
|
- Operation ID: `processor_signal_evaluate`
|
|
- Route: `POST /processor/signal/evaluate`
|
|
- Mode: WRITE
|
|
- Summary: Evaluate a planned ACH transaction
|
|
- Body: JSON request body accepted.
|
|
|
|
### processor_signal_decision_report
|
|
|
|
- Operation ID: `processor_signal_decision_report`
|
|
- Route: `POST /processor/signal/decision/report`
|
|
- Mode: WRITE
|
|
- Summary: Report whether you initiated an ACH transaction
|
|
- Body: JSON request body accepted.
|
|
|
|
### processor_signal_return_report
|
|
|
|
- Operation ID: `processor_signal_return_report`
|
|
- Route: `POST /processor/signal/return/report`
|
|
- Mode: WRITE
|
|
- Summary: Report a return for an ACH transaction
|
|
- Body: JSON request body accepted.
|
|
|
|
### processor_signal_prepare
|
|
|
|
- Operation ID: `processor_signal_prepare`
|
|
- Route: `POST /processor/signal/prepare`
|
|
- Mode: WRITE
|
|
- Summary: Opt-in a processor token to Signal
|
|
- Body: JSON request body accepted.
|
|
|
|
### processor_bank_transfer_create
|
|
|
|
- Operation ID: `processor_bank_transfer_create`
|
|
- Route: `POST /processor/bank_transfer/create`
|
|
- Mode: WRITE
|
|
- Summary: Create a bank transfer as a processor
|
|
- Body: JSON request body accepted.
|
|
|
|
### processor_liabilities_get
|
|
|
|
- Operation ID: `processor_liabilities_get`
|
|
- Route: `POST /processor/liabilities/get`
|
|
- Mode: WRITE
|
|
- Summary: Retrieve Liabilities data
|
|
- Body: JSON request body accepted.
|
|
|
|
### processor_identity_get
|
|
|
|
- Operation ID: `processor_identity_get`
|
|
- Route: `POST /processor/identity/get`
|
|
- Mode: WRITE
|
|
- Summary: Retrieve Identity data
|
|
- Body: JSON request body accepted.
|
|
|
|
### processor_identity_match
|
|
|
|
- Operation ID: `processor_identity_match`
|
|
- Route: `POST /processor/identity/match`
|
|
- Mode: WRITE
|
|
- Summary: Retrieve identity match score
|
|
- Body: JSON request body accepted.
|
|
|
|
### processor_balance_get
|
|
|
|
- Operation ID: `processor_balance_get`
|
|
- Route: `POST /processor/balance/get`
|
|
- Mode: WRITE
|
|
- Summary: Retrieve Balance data
|
|
- Body: JSON request body accepted.
|
|
|
|
### processor_token_create
|
|
|
|
- Operation ID: `processor_token_create`
|
|
- Route: `POST /processor/token/create`
|
|
- Mode: WRITE
|
|
- Summary: Create processor token
|
|
- Body: JSON request body accepted.
|
|
|
|
### processor_token_permissions_set
|
|
|
|
- Operation ID: `processor_token_permissions_set`
|
|
- Route: `POST /processor/token/permissions/set`
|
|
- Mode: WRITE
|
|
- Summary: Control a processor's access to products
|
|
- Body: JSON request body accepted.
|
|
|
|
### processor_token_permissions_get
|
|
|
|
- Operation ID: `processor_token_permissions_get`
|
|
- Route: `POST /processor/token/permissions/get`
|
|
- Mode: WRITE
|
|
- Summary: Get a processor token's product permissions
|
|
- Body: JSON request body accepted.
|
|
|
|
### processor_token_webhook_update
|
|
|
|
- Operation ID: `processor_token_webhook_update`
|
|
- Route: `POST /processor/token/webhook/update`
|
|
- Mode: WRITE
|
|
- Summary: Update a processor token's webhook URL
|
|
- Body: JSON request body accepted.
|
|
|
|
### processor_stripe_bank_account_token_create
|
|
|
|
- Operation ID: `processor_stripe_bank_account_token_create`
|
|
- Route: `POST /processor/stripe/bank_account_token/create`
|
|
- Mode: WRITE
|
|
- Summary: Create Stripe bank account token
|
|
- Body: JSON request body accepted.
|
|
|
|
### processor_apex_processor_token_create
|
|
|
|
- Operation ID: `processor_apex_processor_token_create`
|
|
- Route: `POST /processor/apex/processor_token/create`
|
|
- Mode: WRITE
|
|
- Summary: Create Apex bank account token
|
|
- Body: JSON request body accepted.
|