Banking and spend
The Wingspan Wallet, bank accounts, transfers, cards, tax withholding, bookkeeping transactions, reports, and cashback in the V3 API, and which guide covers each task.
Banking and spend covers the money your own Account holds and spends: the Wingspan Wallet and its balances, the bank accounts linked to it, transfers between them, debit cards, a tax withholding savings account, and the bookkeeping that records it all. Everything here lives under /v3/finance.
This is different from paying people. To pay a payee, see Send payments. To get paid by clients, see Get paid.
Pick a task
| You want to | Read | Main endpoints |
|---|---|---|
| See your Wallet, its numbers, balance, and ledger | Internal accounts and balances | /v3/finance/internal-accounts |
| Move money between the Wallet and a bank account | Move money with transfers | /v3/finance/transfers |
| Download a monthly statement | Account statements | /v3/finance/internal-accounts/{internalAccountId}/statements |
| Link a bank account and verify it | Link and verify a bank account | /v3/finance/external-bank-accounts |
| Rename, reconnect, check, or remove a bank account | Manage a bank account | /v3/finance/external-bank-accounts/{bankAccountId} |
| Find out what a country or currency needs to register a bank account | Bank account countries and institutions | /v3/finance/bank-account-countries, /v3/finance/institutions |
| Order a debit card | Issue a card | /v3/finance/cards |
| Set a PIN or limits, show card details, add to a phone wallet | Card controls and digital wallets | /v3/finance/cards/{cardId}/... |
| Set aside tax money and schedule IRS payments | Tax withholding | /v3/finance/tax-withholdings |
| Estimate what you owe | Tax estimates | /v3/finance/tax-estimates |
| Record and categorize income and expenses | Transactions and categories | /v3/finance/transactions, /v3/finance/transaction-categories |
| Report profit, income, and expenses | Profit and loss and insights | /v3/finance/profit-and-loss, /v3/finance/insights |
| Check or redeem cashback | Cashback | /v3/finance/cashback |
Cards you save so you can pay with them, PaymentCard, are a different resource. See Payment and payout methods.
Things every endpoint here shares
- Scope. Each operation needs one scope. Wallet, transfers, and tax withholding use
bookkeeping.business-banking-account:reador:write. Transactions usebookkeeping.transaction:reador:write. Reports and cashback usebookkeeping.service:reador:write. Bank accounts and bank-account countries usepayments.funding-source:reador:write. Cards usepayments.card:reador:write. Wallet balance usesbookkeeping.business-banking-balance:read. A credential without the scope gets403. - Which Account. Calls act on the Account your credential belongs to. To act for another Account, send
X-Wingspan-Account. See Acting on behalf of accounts. - Money amounts. Amounts are JSON numbers in major units, such as
1250.00for 1,250 dollars. - Idempotency. Calls that move money require an
Idempotency-Keyheader: creating a transfer, depositing or withdrawing tax money, scheduling or cancelling a tax payment, creating a bank account, and redeeming cashback. Reuse the key to retry. Use a new key for a new request. See Idempotency. - MFA step-up. If you call with a person's login session, bank account changes and money movements can return
403withcode: StepUpMfaRequired. Create a challenge atPOST /v3/platform/mfa-challenges, verify it, and retry. Bank account changes ask forrequiredFor: "BankAccountChange". Transfers and tax movements ask forrequiredFor: "HighRiskWriteAction". A backend using an API key has no session to step up. See Environments and authentication. - Lists. List endpoints take
page[size](default 25, maximum 100) andpage[token], and returnpagination.nextPageToken. Filters look likefilter[status][eq]=Active. See Pagination and Filtering, sorting, and expanding. - Errors. Errors use the standard problem format. See Errors. A
503withdetailCode: finance.UpstreamContractViolationmeans a Wingspan service returned data this API couldn't use. Retry later, and contact support with therequestIdif it persists.
Updated about 1 hour ago
Did this page help you?