| Methods |
public
|
createIncomingTransfer(
CreateIncomingTransferRequest $requestBody,
array $headerParameters = [],
string $fetch = self::FETCH_OBJECT,
): Transfer|ResponseInterface|null
This endpoint creates a new incoming transfer. You may use use any eligible bank account connection to fund (ACH Debit)…
This endpoint creates a new incoming transfer. You may use use any eligible bank account connection to fund (ACH Debit)
any active Brex cash account.
Reminder*: You may not use the Brex API for any activity that requires a license or registration from any.
Parameters
| $headerParameters |
{
|
| $fetch |
Fetch mode to use (can be OBJECT or RESPONSE)
|
|
#
|
public
|
listLinkedAccounts(
array $queryParameters = [],
string $fetch = self::FETCH_OBJECT,
): PageBankConnection|ResponseInterface|null
This endpoint lists all bank connections that are eligible to make ACH transfers to Brex cash account
This endpoint lists all bank connections that are eligible to make ACH transfers to Brex cash account
Parameters
| $queryParameters |
{
|
| $fetch |
Fetch mode to use (can be OBJECT or RESPONSE)
|
Throws
|
#
|
public
|
listTransfers(array $queryParameters = [], string $fetch = self::FETCH_OBJECT): PageTransfer|ResponseInterface|null
This endpoint lists existing transfers for an account.
This endpoint lists existing transfers for an account.
Currently, the API can only return transfers for the following payment rails:
- ACH
- DOMESTIC_WIRE
- CHEQUE
- INTERNATIONAL_WIRE
Parameters
| $queryParameters |
{
|
| $fetch |
Fetch mode to use (can be OBJECT or RESPONSE)
|
Throws
|
#
|
public
|
createTransfer(
CreateTransferRequest $requestBody,
array $headerParameters = [],
string $fetch = self::FETCH_OBJECT,
): Transfer|ResponseInterface|null
This endpoint creates a new transfer.
This endpoint creates a new transfer.
Currently, the API can only create transfers for the following payment rails:
- ACH
- DOMESTIC_WIRE
- CHEQUE
- INTERNATIONAL_WIRES (For vendors already created through dashboard. Rate limited to 100/day - Please reach out to [email protected] if you need to do more)
Transaction Descriptions*
For outgoing check payments, a successful transfer will return a response containing a description value with a format of Check #<check number> to <recipient_name> - <external_memo>.
For book transfers (from one Brex Cash account to another), the recipient value will have a format of <customer_account.dba_name> - <external_memo> and the sender will have a format of <target customer account's dba name> - <external_memo>.
For other payment rails, the format will be <counterparty_name> - <external_memo>, where Counterparty name is payment_instrument.beneficiary_name or contact.name.
For vendors created from the Payments API, the counterparty_name will be the company_name field.
Reminder*: You may not use the Brex API for any activity that requires a license or registration from any
Parameters
| $headerParameters |
{
|
| $fetch |
Fetch mode to use (can be OBJECT or RESPONSE)
|
|
#
|
public
|
getTransfersById(string $id, string $fetch = self::FETCH_OBJECT): Transfer|ResponseInterface|null
This endpoint gets a transfer by ID.
This endpoint gets a transfer by ID.
Parameters
| $fetch |
Fetch mode to use (can be OBJECT or RESPONSE)
|
Throws
|
#
|
public
|
listVendors(array $queryParameters = [], string $fetch = self::FETCH_OBJECT): PageVendorResponse|ResponseInterface|null
This endpoint lists all existing vendors for an account.
Takes an optional parameter to match by vendor name.
This endpoint lists all existing vendors for an account.
Takes an optional parameter to match by vendor name.
Parameters
| $queryParameters |
{
|
| $fetch |
Fetch mode to use (can be OBJECT or RESPONSE)
|
Throws
|
#
|
public
|
createVendor(
CreateVendorRequest $requestBody,
array $headerParameters = [],
string $fetch = self::FETCH_OBJECT,
): VendorResponse|ResponseInterface|null
This endpoint creates a new vendor.
This endpoint creates a new vendor.
Parameters
| $headerParameters |
{
|
| $fetch |
Fetch mode to use (can be OBJECT or RESPONSE)
|
|
#
|
public
|
deleteVendor(string $id, string $fetch = self::FETCH_OBJECT): ResponseInterface|null
This endpoint deletes a vendor by ID.
This endpoint deletes a vendor by ID.
Parameters
| $fetch |
Fetch mode to use (can be OBJECT or RESPONSE)
|
|
#
|
public
|
getVendorById(string $id, string $fetch = self::FETCH_OBJECT): VendorResponse|ResponseInterface|null
This endpoint gets a vendor by ID.
This endpoint gets a vendor by ID.
Parameters
| $fetch |
Fetch mode to use (can be OBJECT or RESPONSE)
|
Throws
|
#
|
public
|
updateVendor(
string $id,
UpdateVendorRequest $requestBody,
array $headerParameters = [],
string $fetch = self::FETCH_OBJECT,
): VendorResponse|ResponseInterface|null
Updates an existing vendor by ID.
Updates an existing vendor by ID.
Parameters
| $headerParameters |
{
|
| $fetch |
Fetch mode to use (can be OBJECT or RESPONSE)
|
|
#
|
public
static
|
create($httpClient = null, array $additionalPlugins = [], array $additionalNormalizers = [])
|
#
|