Tools

Brex

Manage expenses, receipts, transactions, and team data in Brex

Usage Instructions

Integrates Brex into the workflow. List and update expenses, upload and match receipts, view card and cash transactions, accounts, budgets, spend limits, vendors, transfers, and team data.

Tools

`brex_list_expenses`

List expenses in the Brex account with optional filters for user, status, payment status, and purchase date range

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Brex user token (generated from Developer Settings in the Brex dashboard)
`userIds`	string	No	Comma-separated user IDs to filter expenses by owner
`statuses`	string	No	Comma-separated expense statuses to filter by: DRAFT, SUBMITTED, APPROVED, OUT_OF_POLICY, VOID, CANCELED, SPLIT, SETTLED
`paymentStatuses`	string	No	Comma-separated payment statuses to filter by: NOT_STARTED, PROCESSING, CANCELED, DECLINED, CLEARED, REFUNDING, REFUNDED, CASH_ADVANCE, CREDITED, AWAITING_PAYMENT, SCHEDULED
`purchasedAtStart`	string	No	Only include expenses purchased at or after this ISO 8601 timestamp
`purchasedAtEnd`	string	No	Only include expenses purchased at or before this ISO 8601 timestamp
`cursor`	string	No	Pagination cursor from a previous response
`limit`	string	No	Number of expenses to return (max 100)

Output

Parameter	Type	Description
`items`	array	Expenses matching the filters
`nextCursor`	string	Cursor for fetching the next page of results

`brex_get_expense`

Get a single Brex expense by its ID, including merchant, user, and receipt details

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Brex user token (generated from Developer Settings in the Brex dashboard)
`expenseId`	string	Yes	ID of the expense to fetch

Output

Parameter	Type	Description
`id`	string	Unique expense ID
`memo`	string	Memo on the expense
`status`	string	Expense status (DRAFT, SUBMITTED, APPROVED, OUT_OF_POLICY, VOID, CANCELED, SPLIT, SETTLED)
`paymentStatus`	string	Payment status (NOT_STARTED, PROCESSING, CANCELED, DECLINED, CLEARED, REFUNDING, REFUNDED, CASH_ADVANCE, CREDITED, AWAITING_PAYMENT, SCHEDULED)
`expenseType`	string	Expense type (CARD, BILLPAY, REIMBURSEMENT, CLAWBACK, UNSET)
`category`	string	Expense category (e.g., RESTAURANTS, RECURRING_SOFTWARE_AND_SAAS, AIRLINE_EXPENSES)
`merchantId`	string	Merchant ID
`merchant`	json	Merchant details (raw descriptor, MCC, country)
`budgetId`	string	Budget ID
`budget`	json	Budget the expense belongs to
`departmentId`	string	Department ID
`department`	json	Department of the expense owner
`locationId`	string	Location ID
`location`	json	Location of the expense owner
`userId`	string	ID of the user who made the expense
`user`	json	User who made the expense
`originalAmount`	json	Original transaction amount
`billingAmount`	json	Amount billed to the account
`purchasedAmount`	json	Amount at the time of purchase
`usdEquivalentAmount`	json	USD equivalent amount
`purchasedAt`	string	Purchase timestamp (ISO 8601)
`updatedAt`	string	Last update timestamp (ISO 8601)
`paymentPostedAt`	string	Timestamp the payment was posted (ISO 8601)
`receipts`	array	Receipts attached to the expense
`dashboardUrl`	string	Link to the expense in the Brex dashboard

`brex_update_expense`

Update the memo of a Brex card expense

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Brex user token (generated from Developer Settings in the Brex dashboard)
`expenseId`	string	Yes	ID of the card expense to update
`memo`	string	Yes	New memo for the expense

Output

Parameter	Type	Description
`id`	string	Unique expense ID
`memo`	string	Updated memo on the expense
`status`	string	Expense status (DRAFT, SUBMITTED, APPROVED, OUT_OF_POLICY, VOID, CANCELED, SPLIT, SETTLED)
`paymentStatus`	string	Payment status (NOT_STARTED, PROCESSING, CANCELED, DECLINED, CLEARED, REFUNDING, REFUNDED, CASH_ADVANCE, CREDITED, AWAITING_PAYMENT, SCHEDULED)
`category`	string	Expense category (e.g., RESTAURANTS, RECURRING_SOFTWARE_AND_SAAS, AIRLINE_EXPENSES)
`merchantId`	string	Merchant ID
`budgetId`	string	Budget ID
`originalAmount`	json	Original transaction amount
`billingAmount`	json	Amount billed to the account
`purchasedAt`	string	Purchase timestamp (ISO 8601)
`updatedAt`	string	Last update timestamp (ISO 8601)

`brex_upload_receipt`

Upload a receipt file and attach it to a specific Brex card expense

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Brex user token (generated from Developer Settings in the Brex dashboard)
`expenseId`	string	Yes	ID of the card expense to attach the receipt to
`file`	file	Yes	Receipt file to upload (max 50 MB)
`receiptName`	string	No	Receipt file name including extension (defaults to the uploaded file name)

Output

Parameter	Type	Description
`receiptId`	string	Unique identifier of the receipt upload
`receiptName`	string	Name the receipt was uploaded with
`expenseId`	string	ID of the expense the receipt was attached to

`brex_match_receipt`

Upload a receipt file and let Brex automatically match it with existing expenses

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Brex user token (generated from Developer Settings in the Brex dashboard)
`file`	file	Yes	Receipt file to upload (max 50 MB)
`receiptName`	string	No	Receipt file name including extension (defaults to the uploaded file name)

Output

Parameter	Type	Description
`receiptId`	string	Unique identifier of the receipt match request
`receiptName`	string	Name the receipt was uploaded with
`expenseId`	string	Always null for receipt match (Brex matches the receipt asynchronously)

`brex_list_card_transactions`

List settled card transactions for all Brex card accounts

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Brex user token (generated from Developer Settings in the Brex dashboard)
`userIds`	string	No	Comma-separated user IDs to filter transactions by cardholder
`postedAtStart`	string	No	Only include transactions posted at or after this ISO 8601 timestamp
`cursor`	string	No	Pagination cursor from a previous response
`limit`	string	No	Number of transactions to return (default 100, max 1000)

Output

Parameter	Type	Description
`items`	array	Settled card transactions
`nextCursor`	string	Cursor for fetching the next page of results

`brex_list_cash_transactions`

List transactions for a Brex cash account

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Brex user token (generated from Developer Settings in the Brex dashboard)
`accountId`	string	Yes	ID of the cash account to list transactions for
`postedAtStart`	string	No	Only include transactions posted at or after this ISO 8601 timestamp
`cursor`	string	No	Pagination cursor from a previous response
`limit`	string	No	Number of transactions to return (default 100, max 1000)

Output

Parameter	Type	Description
`items`	array	Cash account transactions
`nextCursor`	string	Cursor for fetching the next page of results

`brex_list_card_accounts`

List all Brex card accounts with balances and limits

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Brex user token (generated from Developer Settings in the Brex dashboard)

Output

Parameter	Type	Description
`accounts`	array	Card accounts

`brex_list_cash_accounts`

List all Brex cash accounts with balances and account details

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Brex user token (generated from Developer Settings in the Brex dashboard)
`cursor`	string	No	Pagination cursor from a previous response
`limit`	string	No	Number of accounts to return (default 100, max 1000)

Output

Parameter	Type	Description
`items`	array	Cash accounts
`nextCursor`	string	Cursor for fetching the next page of results

`brex_get_cash_account`

Get a Brex cash account by ID, or the primary cash account when no ID is provided

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Brex user token (generated from Developer Settings in the Brex dashboard)
`accountId`	string	No	ID of the cash account (defaults to the primary cash account)

Output

Parameter	Type	Description
`id`	string	Unique account ID
`name`	string	Account name
`status`	string	Account status
`currentBalance`	json	Current balance
`availableBalance`	json	Available balance
`accountNumber`	string	Bank account number
`routingNumber`	string	Bank routing number
`primary`	boolean	Whether this is the primary cash account

`brex_list_card_statements`

List finalized statements for the primary Brex card account

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Brex user token (generated from Developer Settings in the Brex dashboard)
`cursor`	string	No	Pagination cursor from a previous response
`limit`	string	No	Number of statements to return (default 100, max 1000)

Output

Parameter	Type	Description
`items`	array	Finalized card account statements
`nextCursor`	string	Cursor for fetching the next page of results

`brex_list_cash_statements`

List finalized statements for a Brex cash account

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Brex user token (generated from Developer Settings in the Brex dashboard)
`accountId`	string	Yes	ID of the cash account to list statements for
`cursor`	string	No	Pagination cursor from a previous response
`limit`	string	No	Number of statements to return (default 100, max 1000)

Output

Parameter	Type	Description
`items`	array	Finalized cash account statements
`nextCursor`	string	Cursor for fetching the next page of results

`brex_list_users`

List users in the Brex account, optionally filtered by email

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Brex user token (generated from Developer Settings in the Brex dashboard)
`email`	string	No	Filter users by exact email address
`cursor`	string	No	Pagination cursor from a previous response
`limit`	string	No	Number of users to return (default 100, max 1000)

Output

Parameter	Type	Description
`items`	array	Users in the Brex account
`nextCursor`	string	Cursor for fetching the next page of results

`brex_get_user`

Get a Brex user by their ID

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Brex user token (generated from Developer Settings in the Brex dashboard)
`userId`	string	Yes	ID of the user to fetch

Output

Parameter	Type	Description
`id`	string	Unique user ID
`firstName`	string	First name
`lastName`	string	Last name
`email`	string	Email address
`status`	string	User status (INVITED, ACTIVE, CLOSED, DISABLED, DELETED, PENDING_ACTIVATION, INACTIVE, ARCHIVED)
`managerId`	string	ID of the manager
`departmentId`	string	Department ID
`locationId`	string	Location ID
`titleId`	string	Title ID

`brex_get_current_user`

Get the Brex user associated with the API token

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Brex user token (generated from Developer Settings in the Brex dashboard)

Output

Parameter	Type	Description
`id`	string	Unique user ID
`firstName`	string	First name
`lastName`	string	Last name
`email`	string	Email address
`status`	string	User status (INVITED, ACTIVE, CLOSED, DISABLED, DELETED, PENDING_ACTIVATION, INACTIVE, ARCHIVED)
`managerId`	string	ID of the manager
`departmentId`	string	Department ID
`locationId`	string	Location ID
`titleId`	string	Title ID

`brex_list_departments`

List departments in the Brex account, optionally filtered by name

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Brex user token (generated from Developer Settings in the Brex dashboard)
`name`	string	No	Filter departments by name
`cursor`	string	No	Pagination cursor from a previous response
`limit`	string	No	Number of departments to return (default 100, max 1000)

Output

Parameter	Type	Description
`items`	array	Departments in the Brex account
`nextCursor`	string	Cursor for fetching the next page of results

`brex_list_locations`

List locations in the Brex account, optionally filtered by name

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Brex user token (generated from Developer Settings in the Brex dashboard)
`name`	string	No	Filter locations by name
`cursor`	string	No	Pagination cursor from a previous response
`limit`	string	No	Number of locations to return (default 100, max 1000)

Output

Parameter	Type	Description
`items`	array	Locations in the Brex account
`nextCursor`	string	Cursor for fetching the next page of results

`brex_list_titles`

List job titles in the Brex account, optionally filtered by name

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Brex user token (generated from Developer Settings in the Brex dashboard)
`name`	string	No	Filter titles by name
`cursor`	string	No	Pagination cursor from a previous response
`limit`	string	No	Number of titles to return (default 100, max 1000)

Output

Parameter	Type	Description
`items`	array	Job titles in the Brex account
`nextCursor`	string	Cursor for fetching the next page of results

`brex_list_cards`

List cards in the Brex account, optionally filtered by card owner

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Brex user token (generated from Developer Settings in the Brex dashboard)
`userId`	string	No	Filter cards by the ID of the card owner
`cursor`	string	No	Pagination cursor from a previous response
`limit`	string	No	Number of cards to return (default 100, max 1000)

Output

Parameter	Type	Description
`items`	array	Cards in the Brex account
`nextCursor`	string	Cursor for fetching the next page of results

`brex_get_company`

Get the Brex company associated with the API token

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Brex user token (generated from Developer Settings in the Brex dashboard)

Output

Parameter	Type	Description
`id`	string	Unique company ID
`legalName`	string	Legal name of the company
`mailingAddress`	json	Company mailing address (line1, line2, city, state, country, postal_code)
`accountType`	string	Brex account type (BREX_CLASSIC or BREX_EMPOWER)

`brex_list_budgets`

List budgets in the Brex account

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Brex user token (generated from Developer Settings in the Brex dashboard)
`cursor`	string	No	Pagination cursor from a previous response
`limit`	string	No	Number of budgets to return (default 100, max 1000)

Output

Parameter	Type	Description
`items`	array	Budgets in the Brex account
`nextCursor`	string	Cursor for fetching the next page of results

`brex_get_budget`

Get a Brex budget by its ID

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Brex user token (generated from Developer Settings in the Brex dashboard)
`budgetId`	string	Yes	ID of the budget to fetch

Output

Parameter	Type	Description
`budgetId`	string	Unique budget ID
`accountId`	string	Account ID the budget belongs to
`name`	string	Budget name
`description`	string	Budget description
`parentBudgetId`	string	Parent budget ID
`ownerUserIds`	array	User IDs of the budget owners
`periodRecurrenceType`	string	Budget period recurrence (WEEKLY, MONTHLY, QUARTERLY, YEARLY, ONE_TIME)
`startDate`	string	Budget start date
`endDate`	string	Budget end date
`amount`	json	Budget amount
`spendBudgetStatus`	string	Budget status (ACTIVE, ARCHIVED, DELETED)
`limitType`	string	Budget limit type (HARD or SOFT)

`brex_create_budget`

Create a new budget in the Brex account

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Brex user token (generated from Developer Settings in the Brex dashboard)
`name`	string	Yes	Name for the budget
`description`	string	Yes	Description of what the budget is used for
`parentBudgetId`	string	Yes	ID of the parent budget
`periodRecurrenceType`	string	Yes	Period type of the budget (WEEKLY, MONTHLY, QUARTERLY, YEARLY, ONE_TIME)
`amount`	number	Yes	Budget amount, in the smallest unit of the currency (e.g., cents for USD)
`currency`	string	No	ISO 4217 currency code (defaults to USD)
`ownerUserIds`	string	No	Comma-separated user IDs of the budget owners
`startDate`	string	No	Date the budget should start counting (YYYY-MM-DD)
`endDate`	string	No	Date the budget should stop counting (YYYY-MM-DD)

Output

Parameter	Type	Description
`budgetId`	string	Unique budget ID
`accountId`	string	Account ID the budget belongs to
`name`	string	Budget name
`description`	string	Budget description
`parentBudgetId`	string	Parent budget ID
`ownerUserIds`	array	User IDs of the budget owners
`periodRecurrenceType`	string	Budget period recurrence (WEEKLY, MONTHLY, QUARTERLY, YEARLY, ONE_TIME)
`startDate`	string	Budget start date
`endDate`	string	Budget end date
`amount`	json	Budget amount
`spendBudgetStatus`	string	Status of the created budget
`limitType`	string	Budget limit type

`brex_archive_budget`

Archive a Brex budget, making any spend limits beneath it unusable for future expenses and removing it from the UI

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Brex user token (generated from Developer Settings in the Brex dashboard)
`budgetId`	string	Yes	ID of the budget to archive

Output

Parameter	Type	Description
`budgetId`	string	ID of the archived budget
`spendBudgetStatus`	string	Status of the budget after archiving

`brex_list_spend_limits`

List spend limits in the Brex account, optionally filtered by member user

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Brex user token (generated from Developer Settings in the Brex dashboard)
`memberUserIds`	string	No	Comma-separated user IDs to filter spend limits by member
`cursor`	string	No	Pagination cursor from a previous response
`limit`	string	No	Number of spend limits to return (default 100, max 1000)

Output

Parameter	Type	Description
`items`	array	Spend limits in the Brex account
`nextCursor`	string	Cursor for fetching the next page of results

`brex_get_spend_limit`

Get a Brex spend limit by its ID

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Brex user token (generated from Developer Settings in the Brex dashboard)
`spendLimitId`	string	Yes	ID of the spend limit to fetch

Output

Parameter	Type	Description
`id`	string	Unique spend limit ID
`accountId`	string	Account ID the spend limit belongs to
`name`	string	Spend limit name
`description`	string	Spend limit description
`parentBudgetId`	string	Parent budget ID
`status`	string	Spend limit status (ACTIVE, EXPIRED, ARCHIVED)
`periodRecurrenceType`	string	Period recurrence (PER_WEEK, PER_MONTH, PER_QUARTER, PER_YEAR, ONE_TIME)
`spendType`	string	Spend type of the limit
`startDate`	string	Spend limit start date
`endDate`	string	Spend limit end date
`ownerUserIds`	array	User IDs of the spend limit owners
`memberUserIds`	array	User IDs of the spend limit members
`currentPeriodBalance`	json	Spend and rollover amounts for the current period
`authorizationSettings`	json	Authorization settings (base limit, authorization type, rollover refresh)

`brex_create_spend_limit`

Create a new spend limit (hard-authorization card program) in the Brex account

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Brex user token (generated from Developer Settings in the Brex dashboard)
`name`	string	Yes	Name for the spend limit
`periodRecurrenceType`	string	Yes	Period type of the spend limit (PER_WEEK, PER_MONTH, PER_QUARTER, PER_YEAR, ONE_TIME)
`spendType`	string	Yes	Whether the spend limit can only be spent from cards it provisions (BUDGET_PROVISIONED_CARDS_ONLY, NON_BUDGET_PROVISIONED_CARDS_ALLOWED)
`expenseVisibility`	string	Yes	Whether expenses on this spend limit are viewable by all members (SHARED, PRIVATE)
`authorizationVisibility`	string	Yes	Whether the limit amount is visible to all members, or just controllers/bookkeepers/owners (PUBLIC, PRIVATE)
`limitIncreaseSetting`	string	Yes	Whether members can request limit increases (ENABLED, DISABLED)
`autoTransferCardsSetting`	string	Yes	How auto transfer works for virtual cards on this spend limit (DISABLED, ENABLED)
`autoCreateLimitCardsSetting`	string	Yes	How auto limit card creation works for members (DISABLED, ALL_MEMBERS)
`expensePolicyId`	string	Yes	ID of the expense policy corresponding to this spend limit
`baseLimitAmount`	number	Yes	Base spend limit amount, without increases/rollovers, in the smallest unit of the currency (e.g., cents for USD)
`currency`	string	No	ISO 4217 currency code for the base limit (defaults to USD)
`authorizationType`	string	Yes	Whether authorizations decline based on available balance (HARD, SOFT)
`rolloverRefreshRate`	string	Yes	Recurrence at which rolled-over unused funds stop rolling over (OFF, NEVER, PER_MONTH, PER_QUARTER, PER_YEAR)
`limitBufferPercentage`	number	No	Flexible buffer on the limit as a 0-100 percentage
`description`	string	No	Description of what the spend limit is used for
`parentBudgetId`	string	No	ID of the parent budget
`startDate`	string	No	Date the spend limit should start counting (YYYY-MM-DD)
`endDate`	string	No	Date the spend limit should expire (YYYY-MM-DD)
`transactionLimitAmount`	number	No	Per-transaction limit this spend limit enforces, in the smallest unit of the currency
`ownerUserIds`	string	No	Comma-separated user IDs of the spend limit owners
`memberUserIds`	string	No	Comma-separated user IDs of the spend limit members

Output

Parameter	Type	Description
`id`	string	Unique spend limit ID
`accountId`	string	Account ID the spend limit belongs to
`name`	string	Spend limit name
`description`	string	Spend limit description
`parentBudgetId`	string	Parent budget ID
`status`	string	Spend limit status
`periodRecurrenceType`	string	Period recurrence (PER_WEEK, PER_MONTH, PER_QUARTER, PER_YEAR, ONE_TIME)
`spendType`	string	Spend type of the limit
`startDate`	string	Spend limit start date
`endDate`	string	Spend limit end date
`ownerUserIds`	array	User IDs of the spend limit owners
`memberUserIds`	array	User IDs of the spend limit members
`currentPeriodBalance`	json	Spend and rollover amounts for the current period
`authorizationSettings`	json	Authorization settings (base limit, authorization type, rollover refresh)

`brex_list_vendors`

List vendors in the Brex account, optionally filtered by name

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Brex user token (generated from Developer Settings in the Brex dashboard)
`name`	string	No	Filter vendors by name
`cursor`	string	No	Pagination cursor from a previous response
`limit`	string	No	Number of vendors to return (default 100, max 1000)

Output

Parameter	Type	Description
`items`	array	Vendors in the Brex account
`nextCursor`	string	Cursor for fetching the next page of results

`brex_get_vendor`

Get a Brex vendor by its ID

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Brex user token (generated from Developer Settings in the Brex dashboard)
`vendorId`	string	Yes	ID of the vendor to fetch

Output

Parameter	Type	Description
`id`	string	Unique vendor ID
`companyName`	string	Vendor company name
`email`	string	Vendor email address
`phone`	string	Vendor phone number
`paymentAccounts`	array	Payment accounts associated with the vendor

`brex_create_vendor`

Create a new vendor in the Brex account

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Brex user token (generated from Developer Settings in the Brex dashboard)
`companyName`	string	Yes	Name for the vendor (must be unique)
`email`	string	No	Email address for the vendor
`phone`	string	No	Phone number for the vendor

Output

Parameter	Type	Description
`id`	string	Unique vendor ID
`companyName`	string	Vendor company name
`email`	string	Vendor email address
`phone`	string	Vendor phone number
`paymentAccounts`	array	Payment accounts associated with the vendor

`brex_update_vendor`

Update an existing vendor in the Brex account

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Brex user token (generated from Developer Settings in the Brex dashboard)
`vendorId`	string	Yes	ID of the vendor to update
`companyName`	string	No	New name for the vendor
`email`	string	No	New email address for the vendor
`phone`	string	No	New phone number for the vendor

Output

Parameter	Type	Description
`id`	string	Unique vendor ID
`companyName`	string	Vendor company name
`email`	string	Vendor email address
`phone`	string	Vendor phone number
`paymentAccounts`	array	Payment accounts associated with the vendor

`brex_list_transfers`

List money transfers in the Brex account

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Brex user token (generated from Developer Settings in the Brex dashboard)
`cursor`	string	No	Pagination cursor from a previous response
`limit`	string	No	Number of transfers to return (default 100, max 1000)

Output

Parameter	Type	Description
`items`	array	Transfers in the Brex account
`nextCursor`	string	Cursor for fetching the next page of results

`brex_get_transfer`

Get a Brex money transfer by its ID

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Brex user token (generated from Developer Settings in the Brex dashboard)
`transferId`	string	Yes	ID of the transfer to fetch

Output

Parameter	Type	Description
`id`	string	Unique transfer ID
`counterparty`	json	Transfer counterparty details
`description`	string	Transfer description
`paymentType`	string	Payment type (ACH, DOMESTIC_WIRE, CHEQUE, INTERNATIONAL_WIRE, BOOK_TRANSFER, STABLECOIN)
`amount`	json	Transfer amount
`processDate`	string	Date the transfer processes
`originatingAccount`	json	Account the transfer originates from
`status`	string	Transfer status (PROCESSING, SCHEDULED, PENDING_APPROVAL, FAILED, PROCESSED)
`cancellationReason`	string	Reason the transfer was canceled
`estimatedDeliveryDate`	string	Estimated delivery date
`creatorUserId`	string	ID of the user who created the transfer
`createdAt`	string	Creation timestamp
`displayName`	string	Transfer display name
`externalMemo`	string	External memo
`isPproEnabled`	boolean	Whether Principal Protection (PPRO) is enabled

`brex_create_transfer`

Create a money transfer from a Brex cash account to a vendor

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Brex user token (generated from Developer Settings in the Brex dashboard)
`cashAccountId`	string	Yes	ID of the Brex cash account to send the transfer from (found via the /accounts endpoint)
`vendorPaymentInstrumentId`	string	Yes	ID of the vendor's payment instrument to send the transfer to (from the vendor's payment_accounts)
`amount`	number	Yes	Amount to transfer, in the smallest unit of the currency (e.g., cents for USD)
`currency`	string	No	ISO 4217 currency code (defaults to USD)
`description`	string	Yes	Description of the transfer for internal use (not exposed externally)
`externalMemo`	string	Yes	External memo shown to the recipient (max 90 characters for ACH/Wire, 40 for Cheque)
`approvalType`	string	No	Set to MANUAL to require cash admin approval before the transfer is sent
`isPproEnabled`	boolean	No	Enable Principal Protection (PPRO) to have Brex cover intermediary/receiving bank fees (international wires only)

Output

Parameter	Type	Description
`id`	string	Unique transfer ID
`counterparty`	json	Transfer counterparty details
`description`	string	Description of the transfer
`paymentType`	string	Payment type (ACH, DOMESTIC_WIRE, CHEQUE, INTERNATIONAL_WIRE, BOOK_TRANSFER, STABLECOIN)
`amount`	json	Transfer amount
`processDate`	string	Transaction processing date
`originatingAccount`	json	Originating account details for the transfer
`status`	string	Transfer status (PROCESSING, SCHEDULED, PENDING_APPROVAL, FAILED, PROCESSED)
`cancellationReason`	string	Reason the transfer was canceled
`estimatedDeliveryDate`	string	Estimated delivery date for the transfer
`creatorUserId`	string	ID of the user who created the transfer
`createdAt`	string	Creation timestamp of the transfer
`displayName`	string	Human-readable name of the transfer
`externalMemo`	string	External memo of the transfer
`isPproEnabled`	boolean	Whether Principal Protection (PPRO) is enabled for the transfer

Notes

Category: tools
Type: brex

Brandfetch Utilisation du navigateur

On this page

On this page

Usage Instructions

brex_list_expenses

brex_get_expense

brex_update_expense

brex_upload_receipt

brex_match_receipt

brex_list_card_transactions

brex_list_cash_transactions

brex_list_card_accounts

brex_list_cash_accounts

brex_get_cash_account

brex_list_card_statements

brex_list_cash_statements

brex_list_users

brex_get_user

brex_get_current_user

brex_list_departments

brex_list_locations

brex_list_titles

brex_list_cards

brex_get_company

brex_list_budgets

brex_get_budget

brex_create_budget

brex_archive_budget

brex_list_spend_limits

brex_get_spend_limit

brex_create_spend_limit

brex_list_vendors

brex_get_vendor

brex_create_vendor

brex_update_vendor

brex_list_transfers

brex_get_transfer

brex_create_transfer

Brex