103 lines
3.0 KiB
Markdown
103 lines
3.0 KiB
Markdown
---
|
|
name: beta-routes
|
|
description: Handle 11 OpenAPI operation(s) under /beta for the beta route group.
|
|
---
|
|
|
|
# beta API Routes
|
|
|
|
Handle 11 OpenAPI operation(s) under /beta for the beta 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
|
|
|
|
### credit_bank_employment_get
|
|
|
|
- Operation ID: `credit_bank_employment_get`
|
|
- Route: `POST /beta/credit/v1/bank_employment/get`
|
|
- Mode: WRITE
|
|
- Summary: Retrieve information from the bank accounts used for employment verification
|
|
- Body: JSON request body accepted.
|
|
|
|
### transactions_enhance
|
|
|
|
- Operation ID: `transactions_enhance`
|
|
- Route: `POST /beta/transactions/v1/enhance`
|
|
- Mode: WRITE
|
|
- Summary: Enhance locally-held transaction data
|
|
- Body: JSON request body accepted.
|
|
|
|
### transactions_rules_create
|
|
|
|
- Operation ID: `transactions_rules_create`
|
|
- Route: `POST /beta/transactions/rules/v1/create`
|
|
- Mode: WRITE
|
|
- Summary: Create transaction category rule
|
|
- Body: JSON request body accepted.
|
|
|
|
### transactions_rules_list
|
|
|
|
- Operation ID: `transactions_rules_list`
|
|
- Route: `POST /beta/transactions/rules/v1/list`
|
|
- Mode: WRITE
|
|
- Summary: Return a list of rules created for the Item associated with the access token.
|
|
- Body: JSON request body accepted.
|
|
|
|
### transactions_rules_remove
|
|
|
|
- Operation ID: `transactions_rules_remove`
|
|
- Route: `POST /beta/transactions/rules/v1/remove`
|
|
- Mode: WRITE
|
|
- Summary: Remove transaction rule
|
|
- Body: JSON request body accepted.
|
|
|
|
### transactions_user_insights_get
|
|
|
|
- Operation ID: `transactions_user_insights_get`
|
|
- Route: `POST /beta/transactions/user_insights/v1/get`
|
|
- Mode: WRITE
|
|
- Summary: Obtain user insights based on transactions sent through /transactions/enrich
|
|
- Body: JSON request body accepted.
|
|
|
|
### beta_ewa_report_v1_get
|
|
|
|
- Operation ID: `beta_ewa_report_v1_get`
|
|
- Route: `POST /beta/ewa_report/v1/get`
|
|
- Mode: WRITE
|
|
- Summary: Get EWA Score Report
|
|
- Body: JSON request body accepted.
|
|
|
|
### beta_partner_customer_v1_create
|
|
|
|
- Operation ID: `beta_partner_customer_v1_create`
|
|
- Route: `POST /beta/partner/customer/v1/create`
|
|
- Mode: WRITE
|
|
- Summary: Creates a new end customer for a Plaid reseller.
|
|
- Body: JSON request body accepted.
|
|
|
|
### beta_partner_customer_v1_get
|
|
|
|
- Operation ID: `beta_partner_customer_v1_get`
|
|
- Route: `POST /beta/partner/customer/v1/get`
|
|
- Mode: WRITE
|
|
- Summary: Retrieves the details of a Plaid reseller's end customer.
|
|
- Body: JSON request body accepted.
|
|
|
|
### beta_partner_customer_v1_update
|
|
|
|
- Operation ID: `beta_partner_customer_v1_update`
|
|
- Route: `POST /beta/partner/customer/v1/update`
|
|
- Mode: WRITE
|
|
- Summary: Updates an existing end customer.
|
|
- Body: JSON request body accepted.
|
|
|
|
### beta_partner_customer_v1_enable
|
|
|
|
- Operation ID: `beta_partner_customer_v1_enable`
|
|
- Route: `POST /beta/partner/customer/v1/enable`
|
|
- Mode: WRITE
|
|
- Summary: Enables a Plaid reseller's end customer in the Production environment.
|
|
- Body: JSON request body accepted.
|