Check supplier bank details
well_check_supplier_bank_detailsCheck one bank account (IBAN) against what Well knows of one supplier: the supplier's known bank accounts, the day each first appeared, and the payments made to each. It draws no card. Use it when a person forwards new or changed bank details for a supplier ("our supplier changed bank", "nouveau RIB"), from a mail, an invoice or a typed message, before they pay.
Pass the supplier's company_id and the IBAN as given; spaces and lower case are fine. The IBAN is compared exactly, across every currency pocket of the account.
status:
never_seen: the supplier is known and none of its known accounts has this IBAN.already_paid_there: the IBAN is a known account of the supplier and payments to it are on file.known_never_paid: the IBAN is a known account of the supplier, with no payment to it on file.own_account: the IBAN is one of the workspace's own accounts, not a supplier's.unknown_supplier: thecompany_idnames no company this workspace can read. Nothing is known about its accounts.invalid_iban: the value is not a valid IBAN. Nothing was read.
checked_iban gives the checked IBAN's first-seen day and payment count when the supplier has it. accounts lists every known account of the supplier by the last four characters of its IBAN, the checked one first: the day it first appeared (its first payment, or the day Well recorded it when that is earlier), the payment count, the totals per currency and the 10 most recent payments. known_payment_count is every payment to the supplier Well knows; a small number means a thin history, so say how many payments the answer rests on. payments_without_known_account counts payments to the supplier with no known account. accounts_truncated: true means the oldest accounts were not read; the checked IBAN is always read, so never_seen still holds.
The check gives facts and never blocks a payment. Never call new bank details safe from this answer alone.
When the token authorizes one workspace, call this directly — no workspace call is needed first. When it authorizes several, this read will not guess which one you mean: pass workspace_id on the call.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| iban | Yes | The IBAN to check, as given. Spaces and lower case are fine. | |
| company_id | Yes | The supplier's company_id. | |
| workspace_id | No | Target workspace. Omit when the token authorizes one workspace. Required when it authorizes several: this read reports one workspace's own figures and will not choose which. | |
| conversation_id | No | The conversation id returned by the previous Well result, in its meta under well/conversation_id, in its structuredContent, or in its JSON text block. Pass it back on every call in the same conversation, including a call a card makes, so the chosen workspace and the earlier answers still apply. It decides the conversation on its own: nothing the host states about the session replaces it. Omit it only on the first call of a conversation. | |
| workspace_scope | No | Restrict this call to the family: the token's primary workspace plus the company workspaces under it that you are a member of. Unrelated authorized workspaces drop out of the read; row reads merge across the family, while a per-workspace figure still reports exactly one workspace. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| error | No | ||
| status | Yes | ||
| success | Yes | ||
| accounts | Yes | ||
| supplier | Yes | ||
| iban_last4 | Yes | ||
| checked_iban | Yes | ||
| conversation_id | No | The conversation this result belongs to. Pass it back as the conversation_id argument on every later Well call in the same conversation. | |
| newly_connected | No | Tools that connected to this workspace since the last result and that no session was told about yet, oldest first. Present only when at least one tool is new. The connected-line rule says when to tell an entry; when it does, one line per entry, in the person's language: "<name> is connected.". Never fold several entries into one sentence. Each entry comes back once, on one result only: never repeat its line later. | |
| accounts_truncated | Yes | ||
| resolved_workspace | No | The workspace that answered, when the caller named none and the token authorizes several. | |
| known_payment_count | Yes | ||
| conversation_id_note | No | Present only when the server opened a fresh lane, stating that no choice recorded earlier was read. | |
| conversation_id_source | No | Where the conversation id came from: the host's own request meta, the caller's argument, or a fresh lane the server opened. | |
| payments_without_known_account | Yes |