Skip to main content
Users can link external bank accounts to send or receive funds through ACH or other bank-based payment methods.
The Bank Accounts API provides endpoints to add, verify, list, update, and remove bank accounts. Verification is completed using a micro-deposit flow, where two small deposits are sent to the user’s bank account, and the user confirms the amounts.

​
How Bank Accounts Are Used

Bank accounts let users connect their external financial accounts to support a wide range of money movement. You can add accounts, manage defaults, access account details, list all linked accounts, and remove accounts as needed. These accounts can then be used for ACH payments or for adding funds to a user’s Paywint wallet.

​
Available APIs

Add Bank Account

Create a new bank account and link it to a user.

Release Micro-Deposit

Initiate micro-deposits for verifying bank ownership.

Verify Micro-Deposit

Confirm the two deposit amounts to complete verification.

Get Bank Account

Retrieve details of a specific bank account.

List Bank Accounts

Get all bank accounts linked to a user.

Delete Bank Account

Remove a bank account that belongs to a user.

​
How Bank Verification Works

Bank verification ensures the account belongs to the user before it can be used for ACH payments or transfers.
The verification flow is completed in three steps:
1

1. Add the bank account

Call Add Bank Account with the account number, routing number, bank details, and account type.
This adds the bank account to the user’s profile.
2

2. Release micro-deposits

Call Release Micro-Deposit to initiate two small verification deposits to the bank account.
These amounts will appear on the user’s bank statement within 1–2 business days.
In Sandbox, the values are always 0.07 and 0.15.
3

3. Verify the amounts

After the user checks their bank statement, call Verify Micro-Deposit with the two deposit values.
Once verified, the bank account can be used for ACH payments.

​
Managing Bank Accounts

1

Retrieve account details

Use Get Bank Account to access account type, last 4 digits, routing number, verification status, and metadata.
2

List all accounts

Use List Bank Accounts to fetch all accounts linked to a user, ordered by most recently added.
3

Set a default bank account

Use Set Default to switch the default account.
4

Delete an account

Use Delete Bank Account to remove an account.
If the deleted account was default, the next most recent account becomes default automatically.

​
Verification States

Bank accounts move through the following statuses:
StatusDescription
not_appliedNo verification started yet
pendingMicro-deposits have been released and are awaiting verification
appliedUser submitted verification amounts; processing
verifiedVerified successfully; bank account can be used for transfers
failedVerification failed; new micro-deposit release is required

​
Best Practices

  • Always display the last 4 digits of the bank account number for user confirmation
  • Encourage users to wait 1–2 business days for real micro-deposits
  • In Sandbox, verification requires exactly 0.07 and 0.15
  • Use the default account for ACH and payouts unless overridden per request