Create transfer
POST {{baseUrl}}/v1/transfers
This endpoint creates a new transfer.
Currently, the API can only create transfers for the following payment rails: - ACH - DOMESTICWIRE - CHEQUE - INTERNATIONALWIRES (For vendors already created through dashboard. Rate limited to 100/day - Please reach out to developer-support@brex.com if you need to do more)
- For outgoing check payments, it will be
Check #<check number> to <recipient_name> - <external_memo>
. - For book transfers, the recipient will have
<customer_account.dba_name> - <external_memo>
. For book transfers, the sender will have
<target customer account's dba name> - <external_memo>
.For other payment rails, it'll be
<counterparty_name> - <external_memo>
. Counterparty name ispayment_instrument.beneficiary_name
orcontact.name
For vendors created from the Payments API, thecounterparty_name
will be thecompany_name
field.
Reminder: You may not use the Brex API for any activity that requires a license or registration from any governmental authority without Brex's prior review and approval. This includes but is not limited to any money services business or money transmission activity.
Please review the Brex Access Agreement and contact us if you have any questions.
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Idempotency-Key | string | (Required) | |
Content-Type | string |
RESPONSES
status: OK
{"amount":{"amount":36143628,"currency":"Lorem quis"},"id":"commodo cillum","originating_account":{"id":"adipisicing pariatur","type":"BREX_CASH"},"payment_type":"CHEQUE","status":"PROCESSING","counterparty":{"id":"non ut","payment_instrument_id":"ullamco Duis non","type":"VENDOR"},"description":"enim ea","process_date":"2001-11-21","estimated_delivery_date":"1956-08-22","creator_user_id":"occaecat nostrud","created_at":"1970-09-23"}