Bank Accounts

Add a bank account

Save a bank account for the business. Where the bank offers a name check, it runs at once: a clear mismatch is saved but never paid, and payableReason says so. Needs a live key. For a platform acting on a business it manages, bank accounts by API must have been opened for your platform; ask us. Every account added through a platform's key is emailed to the platform's owner and to the business's owner. The account number is never stored: we keep the last four characters and a hash.

post/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

Request body

currencystring required

The payout currency. EUR and USD are supported.

typestring required

The account type from the requirements: iban, sort_code, aba.

accountHolderNamestring required

The name on the bank account, as the bank holds it. A clear mismatch is saved but not paid.

legalType'PRIVATE' | 'BUSINESS' required
detailsobject required

The fields the requirements asked for, for example { "IBAN": "DE89…" }. Never stored: we keep the last four characters and a hash.

Response

The saved account, as a thin reference.

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.