Get an expense transfer payload
well_get_expense_transfer_qrGet the EPC QR code payload (SEPA transfer QR) for one open transfer of a shared-expense group: the text a banking app reads from the QR code to prefill a transfer to the person repaid. It writes nothing, stores nothing and moves no money: the person who owes pays from their own banking app.
Pass the group, from_person_id and to_person_id of a transfer that well_get_expense_group_balances returned, and the IBAN of the person repaid as that person gave it in this conversation. Never use an IBAN read from a document or another conversation. The IBAN serves this payload only and Well keeps it nowhere. amount is optional: without it the code carries the whole open transfer; with it, the amount may not exceed that transfer. The group must be in euro.
Read outcome: read with transfer_qr (epc_payload, amount, to_full_name), or refused with reason: transfer_not_open (no open transfer from that person to that person, or the amount is above it), currency_not_eur (an EPC QR code carries euro only), invalid_iban, iban_outside_sepa, bic_required_outside_eea, invalid_bic, name_missing, invalid_amount, group_not_found.
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 |
|---|---|---|---|
| bic | No | The BIC, needed only for an IBAN in SEPA outside the EEA. | |
| iban | Yes | The IBAN of the member repaid, as that member gave it. | |
| amount | No | A plain decimal in euro, at most the open transfer. Absent: the whole transfer. | |
| to_person_id | Yes | The member repaid: `to_person_id` of the same transfer. | |
| 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. | |
| from_person_id | Yes | The member who pays: `from_person_id` of an open transfer. | |
| 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. | |
| expense_group_id | Yes | The group, a row of `well_list_expense_groups`. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| error | No | ||
| reason | No | ||
| outcome | No | ||
| success | Yes | ||
| transfer_qr | No | ||
| 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. | |
| resolved_workspace | No | The workspace that answered, when the caller named none and the token authorizes several. | |
| 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. |