Skip to content

Brex: Get transfer

Brex payments.paymentsGetTransfersById: arguments, response, policy and SDK examples.

← Payments operations · Get started

Operation brex.payments_gettransfersbyid

Provider route: GET /v1/transfers/{id}. 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"]["paymentsGetTransfersById"]>[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.paymentsGetTransfersById(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_get_transfers_by_id(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.idstringRequired within parent

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

FieldTypePresenceDescription and constraints
$ModelRootExpand Get transfer — response body

Referenced models: Get transfer — response body

Get transfer — response body
FieldTypePresenceDescription and constraints
$objectRoot
amountModelRequired within parentExpand Get transfer — response body — amount
cancellation_reasonJSONOptional
cancellation_reason (anyOf 1)JSONAlternative
cancellation_reason (anyOf 1) (allOf 1)stringAll 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)nullAlternative
counterpartyJSONOptional
counterparty (anyOf 1)JSONAlternative
counterparty (anyOf 1) (allOf 1)ModelAll variants applyExpand Get transfer — response body — counterparty object object
counterparty (anyOf 2)nullAlternative
created_atJSONOptional
created_at (anyOf 1)stringAlternativeDate of transfer creation
Format: date
created_at (anyOf 2)nullAlternative
creator_user_idJSONOptional
creator_user_id (anyOf 1)stringAlternativeUser ID of the transfer initiator
creator_user_id (anyOf 2)nullAlternative
descriptionJSONOptional
description (anyOf 1)stringAlternativeDescription of the transfer
description (anyOf 2)nullAlternative
display_nameJSONOptional
display_name (anyOf 1)stringAlternativeHuman readable name for the transaction
display_name (anyOf 2)nullAlternative
estimated_delivery_dateJSONOptional
estimated_delivery_date (anyOf 1)stringAlternativeEstimated delivery date for transfer
Format: date
estimated_delivery_date (anyOf 2)nullAlternative
external_memoJSONOptional
external_memo (anyOf 1)stringAlternativeExternal 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)nullAlternative
idstringRequired within parentUnique ID associated with the transfer
imadJSONOptional
imad (anyOf 1)stringAlternativeIMAD (Input Message Accountability Data) of the wire
imad (anyOf 2)nullAlternative
is_ppro_enabledJSONOptional
is_ppro_enabled (anyOf 1)booleanAlternativeIf Principal Protection (PPRO) is enabled
is_ppro_enabled (anyOf 2)nullAlternative
omadJSONOptional
omad (anyOf 1)stringAlternativeOMAD (Output Message Accountability Data) of the wire
omad (anyOf 2)nullAlternative
originating_accountModelRequired within parentExpand Get transfer — response body — originating account
payment_typestringRequired within parentKnown values: ACH, DOMESTIC_WIRE, CHEQUE, INTERNATIONAL_WIRE, BOOK_TRANSFER, STABLECOIN
process_dateJSONOptional
process_date (anyOf 1)stringAlternativeTransaction processing date
Format: date
process_date (anyOf 2)nullAlternative
statusModelRequired within parentExpand 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

Get transfer — response body — amount
FieldTypePresenceDescription and constraints
$objectRoot
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.
amountJSONRequired within parent
amount (anyOf 1)integerAlternativeThe 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)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
currencyJSONOptional
currency (anyOf 1)stringAlternativeThe type of currency, in ISO 4217 format.
Default: USD
currency (anyOf 2)nullAlternative
Get transfer — response body — counterparty object object
FieldTypePresenceDescription and constraints
$objectRootCounterparty 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)ModelAlternativeExpand 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
FieldTypePresenceDescription and constraints
$objectRootOriginating account details for the transfer
discriminator: {"mapping": {"BREX_CASH": "#/components/schemas/payments__BrexCashAccountDetailsResponse"}, "propertyName": "type"}
$ (anyOf 1)ModelAlternativeExpand 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
FieldTypePresenceDescription and constraints
$stringRoot`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
Get transfer — response body — counterparty / object / object / type: VENDOR, BOOK TRANSFER, BANK ACCOUNT
FieldTypePresenceDescription and constraints
$objectRoot
$ (allOf 1)objectAll variants applyCounterparty 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.
$ (allOf 2)JSONAll variants apply
$ (allOf 2).account_numberJSONOptional
$ (allOf 2).account_number (anyOf 1)stringAlternativeAccount number of a bank account (or IBAN code for international transfer).
$ (allOf 2).account_number (anyOf 2)nullAlternative
$ (allOf 2).idstringRequired within parentVendor ID returned from `/vendors` endpoint
$ (allOf 2).payment_instrument_idstringRequired within parent
$ (allOf 2).routing_numberJSONOptional
$ (allOf 2).routing_number (anyOf 1)stringAlternativeRouting number of a bank account (or SWIFT/BIC code for international transfer).
$ (allOf 2).routing_number (anyOf 2)nullAlternative
$ (allOf 2).typestringRequired within parentKnown values: VENDOR, BOOK_TRANSFER, BANK_ACCOUNT
Get transfer — response body — originating_account / type: BREX CASH
FieldTypePresenceDescription and constraints
$objectRoot
$ (allOf 1)objectAll variants applyOriginating account details for the transfer
$ (allOf 2)JSONAll variants apply
$ (allOf 2).idstringRequired within parent
ID of the Brex Business account.
$ (allOf 2).typestringRequired within parentKnown values: BREX_CASH

SDK function policy ID: brex.payments_gettransfersbyid. Catalog operation: payments:getTransfersById. 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: ["incoming_transfers", "transfers.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.