Brex: Lists vendors
Brex payments.paymentsListVendors: arguments, response, policy and SDK examples.
← Payments operations · Get started
Operation brex.payments_listvendors
Provider route: GET /v1/vendors. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”Install @alter-ai/sdk @alter-ai/brex with npm, or alter-sdk-brex with pip. Supply your connected customer’s grant ID and the arguments described below.
import { App } from "@alter-ai/sdk";import { BrexIntegration } from "@alter-ai/brex";
async function execute(input: Parameters<BrexIntegration["payments"]["paymentsListVendors"]>[0]) { const app = new App({ apiKey: process.env.ALTER_API_KEY! }); try { const provider = new BrexIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! }); const call = await provider.payments.paymentsListVendors(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom alter_sdk_brex import BrexIntegration
async def execute(arguments): async with App(api_key=os.environ["ALTER_API_KEY"]) as app: provider = BrexIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]}) call = await provider.payments.payments_list_vendors(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
query | object | Optional | Additional keys: not allowed |
query.cursor | JSON | Optional | |
query.cursor (anyOf 1) | string | Alternative | |
query.cursor (anyOf 2) | null | Alternative | |
query.limit | JSON | Optional | |
query.limit (anyOf 1) | integer | Alternative | Format: int32 |
query.limit (anyOf 2) | null | Alternative | |
query.name | JSON | Optional | |
query.name (anyOf 1) | string | Alternative | |
query.name (anyOf 2) | null | Alternative |
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand Lists vendors — response body |
Referenced models: Lists vendors — response body
Schemas
Section titled “Schemas”1 more schema is linked from the tables above, on the schema pages.
Lists vendors — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
items | array | Required within parent | |
items[] | Model | Each item | Expand Get vendor — response body |
next_cursor | JSON | Optional | |
next_cursor (anyOf 1) | string | Alternative | |
next_cursor (anyOf 2) | null | Alternative |
Referenced models: Get vendor — response body
Get vendor — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
company_name | JSON | Optional | |
company_name (anyOf 1) | string | Alternative | |
company_name (anyOf 2) | null | Alternative | |
email | JSON | Optional | |
email (anyOf 1) | string | Alternative | |
email (anyOf 2) | null | Alternative | |
id | string | Required within parent | Vendor ID: Can be passed to /transfers endpoint to specify counterparty. |
payment_accounts | JSON | Optional | |
payment_accounts (anyOf 1) | array | Alternative | |
payment_accounts (anyOf 1)[] | Model | Each item | Expand Get vendor — response body — payment accounts array item |
payment_accounts (anyOf 2) | null | Alternative | |
phone | JSON | Optional | |
phone (anyOf 1) | string | Alternative | |
phone (anyOf 2) | null | Alternative |
Referenced models: Get vendor — response body — payment accounts array item
Get vendor — response body — payment accounts array item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
details | Model | Required within parent | Expand Get vendor — response body — payment accounts array item details |
Referenced models: Get vendor — response body — payment accounts array item details
Get vendor — response body — payment accounts array item details
Referenced models: Get vendor — response body — payment_accounts / array / item / details / type: ACH, DOMESTIC WIRE, CHEQUE, INTERNATIONAL WIRE — payments__ACHDetails Response, Get vendor — response body — payment_accounts / array / item / details / type: ACH, DOMESTIC WIRE, CHEQUE, INTERNATIONAL WIRE — payments__Cheque Details Response, Get vendor — response body — payment_accounts / array / item / details / type: ACH, DOMESTIC WIRE, CHEQUE, INTERNATIONAL WIRE — payments__Domestic Wire Details Response, Get vendor — response body — payment_accounts / array / item / details / type: ACH, DOMESTIC WIRE, CHEQUE, INTERNATIONAL WIRE — payments__International Wire Details Response
Get vendor — response body — payment_accounts / array / item / details / type: ACH, DOMESTIC WIRE, CHEQUE, INTERNATIONAL WIRE — payments__ACHDetails Response
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
$ (allOf 1) | object | All variants apply | |
$ (allOf 2) | JSON | All variants apply | |
$ (allOf 2).account_class | JSON | Optional | |
$ (allOf 2).account_class (anyOf 1) | JSON | Alternative | |
$ (allOf 2).account_class (anyOf 1) (allOf 1) | string | All variants apply | Known values: BUSINESS, PERSONAL |
$ (allOf 2).account_class (anyOf 2) | null | Alternative | |
$ (allOf 2).account_number | string | Required within parent | |
$ (allOf 2).account_type | JSON | Optional | |
$ (allOf 2).account_type (anyOf 1) | JSON | Alternative | |
$ (allOf 2).account_type (anyOf 1) (allOf 1) | string | All variants apply | Known values: CHECKING, SAVING |
$ (allOf 2).account_type (anyOf 2) | null | Alternative | |
$ (allOf 2).payment_instrument_id | string | Required within parent | Payment Instrument ID that can be passed to the /transfers endpoint to trigger a transfer. The type of the payment instrument dictates the method. |
$ (allOf 2).routing_number | string | Required within parent | |
$ (allOf 2).type | string | Required within parent | Known values: ACH, DOMESTIC_WIRE, CHEQUE, INTERNATIONAL_WIRE |
Get vendor — response body — payment_accounts / array / item / details / type: ACH, DOMESTIC WIRE, CHEQUE, INTERNATIONAL WIRE — payments__Cheque Details Response
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
$ (allOf 1) | object | All variants apply | |
$ (allOf 2) | JSON | All variants apply | |
$ (allOf 2).mailing_address | Model | Required within parent | Expand Get card — response body — billing address |
$ (allOf 2).payment_instrument_id | string | Required within parent | Payment Instrument ID that can be passed to the /transfers endpoint to trigger a transfer. The type of the payment instrument dictates the method. |
$ (allOf 2).recipient_name | string | Required within parent | |
$ (allOf 2).type | string | Required within parent | Known values: ACH, DOMESTIC_WIRE, CHEQUE, INTERNATIONAL_WIRE |
Referenced models: Get card — response body — billing address
Get vendor — response body — payment_accounts / array / item / details / type: ACH, DOMESTIC WIRE, CHEQUE, INTERNATIONAL WIRE — payments__Domestic Wire Details Response
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
$ (allOf 1) | object | All variants apply | |
$ (allOf 2) | JSON | All variants apply | |
$ (allOf 2).account_number | string | Required within parent | |
$ (allOf 2).address | Model | Required within parent | Expand Get card — response body — billing address |
$ (allOf 2).payment_instrument_id | string | Required within parent | Payment Instrument ID that can be passed to the /transfers endpoint to trigger a transfer. The type of the payment instrument dictates the method. |
$ (allOf 2).routing_number | string | Required within parent | |
$ (allOf 2).type | string | Required within parent | Known values: ACH, DOMESTIC_WIRE, CHEQUE, INTERNATIONAL_WIRE |
Referenced models: Get card — response body — billing address
Get vendor — response body — payment_accounts / array / item / details / type: ACH, DOMESTIC WIRE, CHEQUE, INTERNATIONAL WIRE — payments__International Wire Details Response
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
$ (allOf 1) | object | All variants apply | |
$ (allOf 2) | JSON | All variants apply | |
$ (allOf 2).address | Model | Required within parent | Expand Get card — response body — billing address |
$ (allOf 2).beneficiary_bank_name | JSON | Optional | |
$ (allOf 2).beneficiary_bank_name (anyOf 1) | string | Alternative | Name of counterparty's bank |
$ (allOf 2).beneficiary_bank_name (anyOf 2) | null | Alternative | |
$ (allOf 2).iban | string | Required within parent | Counterparty's international bank account number |
$ (allOf 2).payment_instrument_id | string | Required within parent | Payment Instrument ID that can be passed to the /transfers endpoint to trigger a transfer. The type of the payment instrument dictates the method. |
$ (allOf 2).swift_code | string | Required within parent | Counterparty's `SWIFT` code |
$ (allOf 2).type | string | Required within parent | Known values: ACH, DOMESTIC_WIRE, CHEQUE, INTERNATIONAL_WIRE |
Referenced models: Get card — response body — billing address
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: brex.payments_listvendors. Catalog operation: payments:listVendors. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.
Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.
Required provider scopes: ["vendors.readonly"]