Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions mintlify/openapi.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 3 additions & 0 deletions openapi.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,23 @@ post:

This endpoint is only for the sandbox environment and will fail for
production platforms/keys.

### Funding a rule-based account

Funding a `RULE_BASED` account triggers its sweep, exactly as a settled
deposit does in production: the balance is swept to the rule's
destination and the account is left at zero. A balance outside the corridor
band moves to the account holder's own account in the same currency
instead, and the transaction carries `sweepCanonicalAccountId` with either
`sweepFailureReason: BELOW_MINIMUM` or `ABOVE_MAXIMUM` — fund a rule-based
account with a very small amount to rehearse that path. Either way the
rule-based account is left at zero; it never holds a balance.

Sandbox simulates the API contract and the routing decision, not the
banking rails. The quote, the corridor bounds, the destination checks and
the webhook are all real; the settlement legs behind them are not, so
timings and failure modes that originate at a partner bank cannot be
reproduced here.
operationId: sandboxFundInternalAccount
tags:
- Sandbox
Expand Down
Loading