Brex: Create transfer
Brex payments.paymentsCreateTransfer: arguments, response, policy and SDK examples.
← Payments operations · Get started
Operation brex.payments_createtransfer
Provider route: POST /v1/transfers. 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"]["paymentsCreateTransfer"]>[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.paymentsCreateTransfer(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_create_transfer(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
headers | object | Required within parent | Additional keys: not allowed |
headers.Idempotency-Key | string | Required within parent | |
body | Model | Required within parent | Expand Create transfer — request body — body |
Referenced models: Create transfer — request body — body
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 Get transfer — response body |
Referenced models: Get transfer — response body
Schemas
Section titled “Schemas”9 more schemas are linked from the tables above, on the schema pages.
Get transfer — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
amount | Model | Required within parent | Expand Get transfer — response body — amount |
cancellation_reason | JSON | Optional | |
cancellation_reason (anyOf 1) | JSON | Alternative | |
cancellation_reason (anyOf 1) (allOf 1) | string | All variants apply | `USER_CANCELLED`: The transfer was canceled. `INSUFFICIENT_FUNDS`: The transfer could not be sent due to insufficient funds. `APPROVAL_DENIED`: The transfer was not sent because it was denied. `BLOCKED_BY_POSITIVE_PAY`: The transfer was blocked because of the ACH debit settings. Known values: USER_CANCELLED, INSUFFICIENT_FUNDS, APPROVAL_DENIED, BLOCKED_BY_POSITIVE_PAY |
cancellation_reason (anyOf 2) | null | Alternative | |
counterparty | JSON | Optional | |
counterparty (anyOf 1) | JSON | Alternative | |
counterparty (anyOf 1) (allOf 1) | Model | All variants apply | Expand Get transfer — response body — counterparty object object |
counterparty (anyOf 2) | null | Alternative | |
created_at | JSON | Optional | |
created_at (anyOf 1) | string | Alternative | Date of transfer creation Format: date |
created_at (anyOf 2) | null | Alternative | |
creator_user_id | JSON | Optional | |
creator_user_id (anyOf 1) | string | Alternative | User ID of the transfer initiator |
creator_user_id (anyOf 2) | null | Alternative | |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | Description of the transfer |
description (anyOf 2) | null | Alternative | |
display_name | JSON | Optional | |
display_name (anyOf 1) | string | Alternative | Human readable name for the transaction |
display_name (anyOf 2) | null | Alternative | |
estimated_delivery_date | JSON | Optional | |
estimated_delivery_date (anyOf 1) | string | Alternative | Estimated delivery date for transfer Format: date |
estimated_delivery_date (anyOf 2) | null | Alternative | |
external_memo | JSON | Optional | |
external_memo (anyOf 1) | string | Alternative | External memo for the transfer. `Payment Instructions` for Wires and the `Entry Description` for ACH payments. Must be at most 90 characters for `ACH` and `WIRE` transactions and at most 40 characters for `CHEQUES` Maximum length: 90 |
external_memo (anyOf 2) | null | Alternative | |
id | string | Required within parent | Unique ID associated with the transfer |
imad | JSON | Optional | |
imad (anyOf 1) | string | Alternative | IMAD (Input Message Accountability Data) of the wire |
imad (anyOf 2) | null | Alternative | |
is_ppro_enabled | JSON | Optional | |
is_ppro_enabled (anyOf 1) | boolean | Alternative | If Principal Protection (PPRO) is enabled |
is_ppro_enabled (anyOf 2) | null | Alternative | |
omad | JSON | Optional | |
omad (anyOf 1) | string | Alternative | OMAD (Output Message Accountability Data) of the wire |
omad (anyOf 2) | null | Alternative | |
originating_account | Model | Required within parent | Expand Get transfer — response body — originating account |
payment_type | string | Required within parent | Known values: ACH, DOMESTIC_WIRE, CHEQUE, INTERNATIONAL_WIRE, BOOK_TRANSFER, STABLECOIN |
process_date | JSON | Optional | |
process_date (anyOf 1) | string | Alternative | Transaction processing date Format: date |
process_date (anyOf 2) | null | Alternative | |
status | Model | Required within parent | Expand Get transfer — response body — status |
Referenced models: Get transfer — response body — amount, Get transfer — response body — counterparty object object, Get transfer — response body — originating account, Get transfer — response body — status
Create transfer — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
amount | Model | Required within parent | Expand Create transfer — request body — body amount |
approval_type | JSON | Optional | |
approval_type (anyOf 1) | JSON | Alternative | |
approval_type (anyOf 1) (allOf 1) | string | All variants apply | Specifies the approval type for the transaction. `MANUAL` requires a cash admin to approve the transaction before disbursing funds. When not set, the default policy will apply. One of: MANUAL |
approval_type (anyOf 2) | null | Alternative | |
counterparty | Model | Required within parent | Expand Create transfer — request body — body counterparty |
description | string | Required within parent | Description of the transfer for internal use. Not exposed externally. |
external_memo | string | Required within parent | External memo for the transfer. `Payment Instructions` for Wires and the `Entry Description` for ACH payments. Must be at most 90 characters for `ACH` and `WIRE` transactions and at most 40 characters for `CHEQUES` Maximum length: 90 |
is_ppro_enabled | boolean | Optional | When set to true, add Principal Protection (PPRO) to the transaction. PPRO means Brex will cover any fees charged by intemediary or receiving banks. PPRO charges will be billed separately in a monthly statement. PPRO is only available for international wire transactions. |
originating_account | JSON | Required within parent | |
originating_account (allOf 1) | Model | All variants apply | Expand Create transfer — request body — body originating account Originating account details for the transfer |
originating_account (allOf 2) | JSON | All variants apply | Brex originating account details. Account IDs are returned by the /accounts endpoint. This endpoint currently only supports accounts with instrument type `CASH` (Brex business accounts) Currently only USD transfers are supported and amount should be positive |
Referenced models: Create transfer — request body — body amount, Create transfer — request body — body counterparty, Create transfer — request body — body originating account Originating account details for the transfer
Get transfer — response body — amount
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Money fields can be signed or unsigned. Fields are signed (an unsigned value will be interpreted as positive). The amount of money will be represented in the smallest denomination of the currency indicated. For example, USD 7.00 will be represented in cents with an amount of 700. |
amount | JSON | Required within parent | |
amount (anyOf 1) | integer | Alternative | The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents. Format: int64 |
amount (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
currency | JSON | Optional | |
currency (anyOf 1) | string | Alternative | The type of currency, in ISO 4217 format. Default: USD |
currency (anyOf 2) | null | Alternative |
Get transfer — response body — counterparty object object
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Counterparty Details for the transfer - Currently only supports vendors that are returned in the response from the /vendors endpoint BOOK_TRANSFER is a limited feature. Please reach out if you are interested. discriminator: {"mapping": {"BANK_ACCOUNT": "#/components/schemas/payments__BankAccountDetailsResponse", "BOOK_TRANSFER": "#/components/schemas/payments__BookTransferDetailsResponse", "VENDOR": "#/components/schemas/payments__VendorDetailsResponse"}, "propertyName": "type"} |
$ (anyOf 1) | Model | Alternative | Expand Get transfer — response body — counterparty / object / object / type: VENDOR, BOOK TRANSFER, BANK ACCOUNT |
Referenced models: Get transfer — response body — counterparty / object / object / type: VENDOR, BOOK TRANSFER, BANK ACCOUNT
Get transfer — response body — originating account
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Originating account details for the transfer discriminator: {"mapping": {"BREX_CASH": "#/components/schemas/payments__BrexCashAccountDetailsResponse"}, "propertyName": "type"} |
$ (anyOf 1) | Model | Alternative | Expand Get transfer — response body — originating_account / type: BREX CASH |
Referenced models: Get transfer — response body — originating_account / type: BREX CASH
Get transfer — response body — status
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | string | Root | `PROCESSING`: We have started to process the sending or receiving of this transaction. `SCHEDULED`: The transaction is scheduled to enter the `PROCESSING` status. `PENDING_APPROVAL`: The transaction requires approval before it can enter the `SCHEDULED` or `PROCESSING` status. `FAILED`: A grouping of multiple terminal states that prevented the transaction from completing. This includes a a user-cancellation, approval being denied, insufficient funds, failed verifications, etc. `PROCESSED`: The money movement has been fully completed, which could mean money sent has arrived. Known values: PROCESSING, SCHEDULED, PENDING_APPROVAL, FAILED, PROCESSED |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: brex.payments_createtransfer. Catalog operation: payments:createTransfer. 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: ["transfers"]