Skip to content

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.

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 os
from alter_sdk import App
from 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()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
queryobjectOptionalAdditional keys: not allowed
query.cursorJSONOptional
query.cursor (anyOf 1)stringAlternative
query.cursor (anyOf 2)nullAlternative
query.limitJSONOptional
query.limit (anyOf 1)integerAlternativeFormat: int32
query.limit (anyOf 2)nullAlternative
query.nameJSONOptional
query.name (anyOf 1)stringAlternative
query.name (anyOf 2)nullAlternative

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand Lists vendors — response body

Referenced models: Lists vendors — response body

1 more schema is linked from the tables above, on the schema pages.

Lists vendors — response body
FieldTypePresenceDescription and constraints
$objectRoot
itemsarrayRequired within parent
items[]ModelEach itemExpand Get vendor — response body
next_cursorJSONOptional
next_cursor (anyOf 1)stringAlternative
next_cursor (anyOf 2)nullAlternative

Referenced models: Get vendor — response body

Get vendor — response body
FieldTypePresenceDescription and constraints
$objectRoot
company_nameJSONOptional
company_name (anyOf 1)stringAlternative
company_name (anyOf 2)nullAlternative
emailJSONOptional
email (anyOf 1)stringAlternative
email (anyOf 2)nullAlternative
idstringRequired within parentVendor ID: Can be passed to /transfers endpoint to specify counterparty.
payment_accountsJSONOptional
payment_accounts (anyOf 1)arrayAlternative
payment_accounts (anyOf 1)[]ModelEach itemExpand Get vendor — response body — payment accounts array item
payment_accounts (anyOf 2)nullAlternative
phoneJSONOptional
phone (anyOf 1)stringAlternative
phone (anyOf 2)nullAlternative

Referenced models: Get vendor — response body — payment accounts array item

Get vendor — response body — payment accounts array item
FieldTypePresenceDescription and constraints
$objectRoot
detailsModelRequired within parentExpand 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
FieldTypePresenceDescription and constraints
$objectRootdiscriminator: {"mapping": {"ACH": "#/components/schemas/payments__ACHDetailsResponse", "CHEQUE": "#/components/schemas/payments__ChequeDetailsResponse", "DOMESTIC_WIRE": "#/components/schemas/payments__DomesticWireDetailsResponse", "INTERNATIONAL_WIRE": "#/components/schemas/payments__InternationalWireDetailsResponse"}, "propertyName": "type"}
$ (anyOf 1)ModelAlternativeExpand Get vendor — response body — payment_accounts / array / item / details / type: ACH, DOMESTIC WIRE, CHEQUE, INTERNATIONAL WIRE — payments__ACHDetails Response
$ (anyOf 2)ModelAlternativeExpand Get vendor — response body — payment_accounts / array / item / details / type: ACH, DOMESTIC WIRE, CHEQUE, INTERNATIONAL WIRE — payments__Domestic Wire Details Response
$ (anyOf 3)ModelAlternativeExpand Get vendor — response body — payment_accounts / array / item / details / type: ACH, DOMESTIC WIRE, CHEQUE, INTERNATIONAL WIRE — payments__Cheque Details Response
$ (anyOf 4)ModelAlternativeExpand Get vendor — response body — payment_accounts / array / item / details / type: ACH, DOMESTIC WIRE, CHEQUE, INTERNATIONAL WIRE — payments__International Wire Details Response

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
FieldTypePresenceDescription and constraints
$objectRoot
$ (allOf 1)objectAll variants apply
$ (allOf 2)JSONAll variants apply
$ (allOf 2).account_classJSONOptional
$ (allOf 2).account_class (anyOf 1)JSONAlternative
$ (allOf 2).account_class (anyOf 1) (allOf 1)stringAll variants applyKnown values: BUSINESS, PERSONAL
$ (allOf 2).account_class (anyOf 2)nullAlternative
$ (allOf 2).account_numberstringRequired within parent
$ (allOf 2).account_typeJSONOptional
$ (allOf 2).account_type (anyOf 1)JSONAlternative
$ (allOf 2).account_type (anyOf 1) (allOf 1)stringAll variants applyKnown values: CHECKING, SAVING
$ (allOf 2).account_type (anyOf 2)nullAlternative
$ (allOf 2).payment_instrument_idstringRequired within parentPayment 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_numberstringRequired within parent
$ (allOf 2).typestringRequired within parentKnown 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
FieldTypePresenceDescription and constraints
$objectRoot
$ (allOf 1)objectAll variants apply
$ (allOf 2)JSONAll variants apply
$ (allOf 2).mailing_addressModelRequired within parentExpand Get card — response body — billing address
$ (allOf 2).payment_instrument_idstringRequired within parentPayment 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_namestringRequired within parent
$ (allOf 2).typestringRequired within parentKnown 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
FieldTypePresenceDescription and constraints
$objectRoot
$ (allOf 1)objectAll variants apply
$ (allOf 2)JSONAll variants apply
$ (allOf 2).account_numberstringRequired within parent
$ (allOf 2).addressModelRequired within parentExpand Get card — response body — billing address
$ (allOf 2).payment_instrument_idstringRequired within parentPayment 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_numberstringRequired within parent
$ (allOf 2).typestringRequired within parentKnown 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
FieldTypePresenceDescription and constraints
$objectRoot
$ (allOf 1)objectAll variants apply
$ (allOf 2)JSONAll variants apply
$ (allOf 2).addressModelRequired within parentExpand Get card — response body — billing address
$ (allOf 2).beneficiary_bank_nameJSONOptional
$ (allOf 2).beneficiary_bank_name (anyOf 1)stringAlternativeName of counterparty's bank
$ (allOf 2).beneficiary_bank_name (anyOf 2)nullAlternative
$ (allOf 2).ibanstringRequired within parentCounterparty's international bank account number
$ (allOf 2).payment_instrument_idstringRequired within parentPayment 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_codestringRequired within parentCounterparty's `SWIFT` code
$ (allOf 2).typestringRequired within parentKnown values: ACH, DOMESTIC_WIRE, CHEQUE, INTERNATIONAL_WIRE

Referenced models: Get card — response body — billing address

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"]

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.