Increase banking API bindings: hold deposits, issue account numbers and cards, and move money over ACH, Fedwire, Real-Time Payments, FedNow, checks and book transfers.
::increase::entities,::increase::accounts(accounts, account numbers, balances, statements) and::increase::external-accounts- transfers, one namespace per rail:
::increase::ach-transfers,::increase::wire-transfers,::increase::rtp-transfers,::increase::fednow-transfers,::increase::check-transfers,::increase::account-transfers ::increase::inbound-transfers: inbound ACH, wire, RTP and FedNow, with ACH returns and declines, wire reversals and RTP returns::increase::transactions: transactions, pending transactions and declined transactions::increase::cards: cards, card details and physical cards::increase::events: events and event subscriptions (webhooks)::increase::simulations: sandbox-only simulations, guarded so they err unlessincrease.environmentis"sandbox"::increase::webhooksand::increase::standard-webhooks: webhook signature verification::increase::api: transport, errors, pagination and thecallescape hatch
Setup: context variables
increase.api.key: an API key from the Increase dashboard (sandbox and production keys differ)increase.environment:"sandbox"(default) or"production"increase.webhook.secret: the event subscription's shared secretincrease.transfers.require-approval:trueto sendrequire_approval: trueon every transfer that doesn't set it
Money movement. Every call that creates a transfer, a return or a
reversal needs an idempotency-key in its trailing opts Map and errs
locally without one. Nothing in this package retries a request.
Agents should create transfers with require_approval: true and leave
the approval to a person.
Quick start
::api ::increase::api
::ach ::increase::ach-transfers
accounts ::increase::accounts/list-accounts({"status.in": ["open"]})
transfer ::ach/create-ach-transfer({
account_id: "account_in71c4amph0vgo2qllky",
external_account_id: "external_account_ukk55lr923a3ac0pp7iv",
amount: 10000,
statement_descriptor: "Invoice 42",
require_approval: true
}, {idempotency-key: "invoice-42-payout"})
Values
DEFAULT_ENVIRONMENT
DEFAULT_ENVIRONMENT: Str "sandbox"
MAX_PAGE_SIZE
MAX_PAGE_SIZE: Int 100
PRODUCTION_URL
PRODUCTION_URL: Str "https://api.increase.com"
SANDBOX_URL
SANDBOX_URL: Str "https://sandbox.increase.com"