239 lines
6.9 KiB
Markdown
239 lines
6.9 KiB
Markdown
---
|
|
name: sandbox-routes
|
|
description: Handle 28 OpenAPI operation(s) under /sandbox for the sandbox route group.
|
|
---
|
|
|
|
# sandbox API Routes
|
|
|
|
Handle 28 OpenAPI operation(s) under /sandbox for the sandbox 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
|
|
|
|
### sandbox_transactions_create
|
|
|
|
- Operation ID: `sandbox_transactions_create`
|
|
- Route: `POST /sandbox/transactions/create`
|
|
- Mode: WRITE
|
|
- Summary: Create sandbox transactions
|
|
- Body: JSON request body accepted.
|
|
|
|
### sandbox_processor_token_create
|
|
|
|
- Operation ID: `sandbox_processor_token_create`
|
|
- Route: `POST /sandbox/processor_token/create`
|
|
- Mode: WRITE
|
|
- Summary: Create a test Item and processor token
|
|
- Body: JSON request body accepted.
|
|
|
|
### sandbox_public_token_create
|
|
|
|
- Operation ID: `sandbox_public_token_create`
|
|
- Route: `POST /sandbox/public_token/create`
|
|
- Mode: WRITE
|
|
- Summary: Create a test Item
|
|
- Body: JSON request body accepted.
|
|
|
|
### sandbox_item_fire_webhook
|
|
|
|
- Operation ID: `sandbox_item_fire_webhook`
|
|
- Route: `POST /sandbox/item/fire_webhook`
|
|
- Mode: WRITE
|
|
- Summary: Fire a test webhook
|
|
- Body: JSON request body accepted.
|
|
|
|
### sandbox_item_reset_login
|
|
|
|
- Operation ID: `sandbox_item_reset_login`
|
|
- Route: `POST /sandbox/item/reset_login`
|
|
- Mode: WRITE
|
|
- Summary: Force a Sandbox Item into an error state
|
|
- Body: JSON request body accepted.
|
|
|
|
### sandbox_item_application_seed
|
|
|
|
- Operation ID: `sandbox_item_application_seed`
|
|
- Route: `POST /sandbox/item/application/seed`
|
|
- Mode: WRITE
|
|
- Summary: Seed a connected application for a Permissions Manager sandbox item
|
|
- Body: JSON request body accepted.
|
|
|
|
### sandbox_item_set_verification_status
|
|
|
|
- Operation ID: `sandbox_item_set_verification_status`
|
|
- Route: `POST /sandbox/item/set_verification_status`
|
|
- Mode: WRITE
|
|
- Summary: Set verification status for Sandbox account
|
|
- Body: JSON request body accepted.
|
|
|
|
### sandbox_user_reset_login
|
|
|
|
- Operation ID: `sandbox_user_reset_login`
|
|
- Route: `POST /sandbox/user/reset_login`
|
|
- Mode: WRITE
|
|
- Summary: Force item(s) for a Sandbox User into an error state
|
|
- Body: JSON request body accepted.
|
|
|
|
### sandbox_bank_transfer_simulate
|
|
|
|
- Operation ID: `sandbox_bank_transfer_simulate`
|
|
- Route: `POST /sandbox/bank_transfer/simulate`
|
|
- Mode: WRITE
|
|
- Summary: Simulate a bank transfer event in Sandbox
|
|
- Body: JSON request body accepted.
|
|
|
|
### sandbox_transfer_sweep_simulate
|
|
|
|
- Operation ID: `sandbox_transfer_sweep_simulate`
|
|
- Route: `POST /sandbox/transfer/sweep/simulate`
|
|
- Mode: WRITE
|
|
- Summary: Simulate creating a sweep
|
|
- Body: JSON request body accepted.
|
|
|
|
### sandbox_transfer_simulate
|
|
|
|
- Operation ID: `sandbox_transfer_simulate`
|
|
- Route: `POST /sandbox/transfer/simulate`
|
|
- Mode: WRITE
|
|
- Summary: Simulate a transfer event in Sandbox
|
|
- Body: JSON request body accepted.
|
|
|
|
### sandbox_transfer_refund_simulate
|
|
|
|
- Operation ID: `sandbox_transfer_refund_simulate`
|
|
- Route: `POST /sandbox/transfer/refund/simulate`
|
|
- Mode: WRITE
|
|
- Summary: Simulate a refund event in Sandbox
|
|
- Body: JSON request body accepted.
|
|
|
|
### sandbox_transfer_ledger_simulate_available
|
|
|
|
- Operation ID: `sandbox_transfer_ledger_simulate_available`
|
|
- Route: `POST /sandbox/transfer/ledger/simulate_available`
|
|
- Mode: WRITE
|
|
- Summary: Simulate converting pending balance to available balance
|
|
- Body: JSON request body accepted.
|
|
|
|
### sandbox_transfer_ledger_deposit_simulate
|
|
|
|
- Operation ID: `sandbox_transfer_ledger_deposit_simulate`
|
|
- Route: `POST /sandbox/transfer/ledger/deposit/simulate`
|
|
- Mode: WRITE
|
|
- Summary: Simulate a ledger deposit event in Sandbox
|
|
- Body: JSON request body accepted.
|
|
|
|
### sandbox_transfer_ledger_withdraw_simulate
|
|
|
|
- Operation ID: `sandbox_transfer_ledger_withdraw_simulate`
|
|
- Route: `POST /sandbox/transfer/ledger/withdraw/simulate`
|
|
- Mode: WRITE
|
|
- Summary: Simulate a ledger withdraw event in Sandbox
|
|
- Body: JSON request body accepted.
|
|
|
|
### sandbox_transfer_repayment_simulate
|
|
|
|
- Operation ID: `sandbox_transfer_repayment_simulate`
|
|
- Route: `POST /sandbox/transfer/repayment/simulate`
|
|
- Mode: WRITE
|
|
- Summary: Trigger the creation of a repayment
|
|
- Body: JSON request body accepted.
|
|
|
|
### sandbox_transfer_fire_webhook
|
|
|
|
- Operation ID: `sandbox_transfer_fire_webhook`
|
|
- Route: `POST /sandbox/transfer/fire_webhook`
|
|
- Mode: WRITE
|
|
- Summary: Manually fire a Transfer webhook
|
|
- Body: JSON request body accepted.
|
|
|
|
### sandbox_transfer_test_clock_create
|
|
|
|
- Operation ID: `sandbox_transfer_test_clock_create`
|
|
- Route: `POST /sandbox/transfer/test_clock/create`
|
|
- Mode: WRITE
|
|
- Summary: Create a test clock
|
|
- Body: JSON request body accepted.
|
|
|
|
### sandbox_transfer_test_clock_advance
|
|
|
|
- Operation ID: `sandbox_transfer_test_clock_advance`
|
|
- Route: `POST /sandbox/transfer/test_clock/advance`
|
|
- Mode: WRITE
|
|
- Summary: Advance a test clock
|
|
- Body: JSON request body accepted.
|
|
|
|
### sandbox_transfer_test_clock_get
|
|
|
|
- Operation ID: `sandbox_transfer_test_clock_get`
|
|
- Route: `POST /sandbox/transfer/test_clock/get`
|
|
- Mode: WRITE
|
|
- Summary: Get a test clock
|
|
- Body: JSON request body accepted.
|
|
|
|
### sandbox_transfer_test_clock_list
|
|
|
|
- Operation ID: `sandbox_transfer_test_clock_list`
|
|
- Route: `POST /sandbox/transfer/test_clock/list`
|
|
- Mode: WRITE
|
|
- Summary: List test clocks
|
|
- Body: JSON request body accepted.
|
|
|
|
### sandbox_payment_profile_reset_login
|
|
|
|
- Operation ID: `sandbox_payment_profile_reset_login`
|
|
- Route: `POST /sandbox/payment_profile/reset_login`
|
|
- Mode: WRITE
|
|
- Summary: Reset the login of a Payment Profile
|
|
- Body: JSON request body accepted.
|
|
|
|
### sandbox_payment_simulate
|
|
|
|
- Operation ID: `sandbox_payment_simulate`
|
|
- Route: `POST /sandbox/payment/simulate`
|
|
- Mode: WRITE
|
|
- Summary: Simulate a payment event in Sandbox
|
|
- Body: JSON request body accepted.
|
|
|
|
### sandbox_bank_transfer_fire_webhook
|
|
|
|
- Operation ID: `sandbox_bank_transfer_fire_webhook`
|
|
- Route: `POST /sandbox/bank_transfer/fire_webhook`
|
|
- Mode: WRITE
|
|
- Summary: Manually fire a Bank Transfer webhook
|
|
- Body: JSON request body accepted.
|
|
|
|
### sandbox_income_fire_webhook
|
|
|
|
- Operation ID: `sandbox_income_fire_webhook`
|
|
- Route: `POST /sandbox/income/fire_webhook`
|
|
- Mode: WRITE
|
|
- Summary: Manually fire an Income webhook
|
|
- Body: JSON request body accepted.
|
|
|
|
### sandbox_bank_income_fire_webhook
|
|
|
|
- Operation ID: `sandbox_bank_income_fire_webhook`
|
|
- Route: `POST /sandbox/bank_income/fire_webhook`
|
|
- Mode: WRITE
|
|
- Summary: Manually fire a Bank Income webhook in Sandbox
|
|
- Body: JSON request body accepted.
|
|
|
|
### sandbox_cra_cashflow_updates_update
|
|
|
|
- Operation ID: `sandbox_cra_cashflow_updates_update`
|
|
- Route: `POST /sandbox/cra/cashflow_updates/update`
|
|
- Mode: WRITE
|
|
- Summary: Trigger an update for Cash Flow Updates
|
|
- Body: JSON request body accepted.
|
|
|
|
### sandbox_oauth_select_accounts
|
|
|
|
- Operation ID: `sandbox_oauth_select_accounts`
|
|
- Route: `POST /sandbox/oauth/select_accounts`
|
|
- Mode: WRITE
|
|
- Summary: Save the selected accounts when connecting to the Platypus OAuth institution
|
|
- Body: JSON request body accepted.
|