Skip to main content
GET
List bank accounts
Thin references only, each with whether the next payout can go to it and, when not, why.

Bank accounts by API

The flow end to end, with the SDK.

Build a platform

Managing businesses, start to finish.

Authorizations

x-api-key
string
header
required

Your secret key, from app.agentaos.ai -> Settings -> Developers -> API Keys. The key's prefix is both its identity and its environment: sk_test_... (sandbox, free, no verification) or sk_live_... (real money, requires business verification). A missing or invalid key returns 401.

Response

The accounts.

id
string<uuid>
required
currency
string
required

Upper-case, EUR or USD.

account_type
string
required

The corridor: iban, sort_code, aba.

account_identifier_last4
string
required

The last four characters of the account number.

account_holder_name
string
required
Available options:
PRIVATE,
BUSINESS
name_match_status
enum<string>
required

How the holder name compared with the name the bank holds, where the bank offers that check (not for every currency). failed is never paid; partial and unknown are paid.

Available options:
success,
partial,
failed,
unknown
active
boolean
required
payable
boolean
required

Can the next payout go to this account right now: active, and the name check did not fail.

payableReason
string | null
required

When payable is false: why, in a sentence for the merchant.