Bank Accounts

List bank accounts

The active bank accounts of the business, thin references only, each with whether the next payout can go to it.

get/gateway/bank-accounts

Request

  • Base URL: https://api.agentaos.ai/api/v1
  • URL: https://api.agentaos.ai/api/v1/gateway/bank-accounts
  • Auth: API key in header x-api-key

Response

The accounts.

idstring uuid required
currencystring required

Upper-case, EUR or USD.

account_typestring required

The corridor: iban, sort_code, aba.

account_identifier_last4string required

The last four characters of the account number.

account_holder_namestring required
legal_type'PRIVATE' | 'BUSINESS' required
name_match_status'success' | 'partial' | 'failed' | 'unknown' 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.

activeboolean required
payableboolean required

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

payableReasonstring nullable required

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

Changes

No recorded changes to this operation across all 1 revision of this API.