Generated by API Evangelist
Written by API Evangelist tooling for Square's API. It is a proposal applied on top of the contract, not a document Square publishes.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Square Bank Accounts API
version: 1.0.0
extends: openapi/square-bank-accounts-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-10-01'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 3
- target: $.paths['/v2/bank-accounts'].get
update:
x-apievangelist-phrasing:
intent: List linked bank accounts
effect: read
questions:
- Which bank accounts are linked to my Square account?
- Can I see only the bank accounts tied to one location?
instructions:
- text: List my linked bank accounts.
- text: List bank accounts for location {location_id}.
slots:
location_id: query.location_id
method: generated
generated: '2026-10-01'
- target: $.paths['/v2/bank-accounts/by-v1-id/{v1_bank_account_id}'].get
update:
x-apievangelist-phrasing:
intent: Get a bank account by its V1 ID
effect: read
questions:
- I only have an old V1 bank account ID; can I still look it up?
- How do I map a legacy V1 bank account ID to its current record?
instructions:
- text: Get the bank account with V1 ID {v1_bank_account_id}.
slots:
v1_bank_account_id: path.v1_bank_account_id
- text: Look up legacy bank account {v1_bank_account_id}.
slots:
v1_bank_account_id: path.v1_bank_account_id
method: generated
generated: '2026-10-01'
- target: $.paths['/v2/bank-accounts/{bank_account_id}'].get
update:
x-apievangelist-phrasing:
intent: Get a linked bank account
effect: read
questions:
- What are the status and details of a specific linked bank account?
- Can I check whether a bank account is verified?
instructions:
- text: Get bank account {bank_account_id}.
slots:
bank_account_id: path.bank_account_id
- text: Show verification status of bank account {bank_account_id}.
slots:
bank_account_id: path.bank_account_id
method: generated
generated: '2026-10-01'
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.