# Payments API


The payments API allows you to initiate and manage payments and vendors from your Brex business accounts.


Version: 1.0

## Servers

Production
```
https://api.brex.com
```

Staging (Note: This is not a sandbox. It will not work with customer tokens.)
```
https://api-staging.brex.com
```

## Security

### OAuth2

OAuth2 security scheme

Type: oauth2

## Download OpenAPI description

[Payments API](https://developer.brex.com/_bundle/openapi/payments_api.yaml)

## Vendors

Endpoints to manage vendors

### Lists vendors

 - [GET /v1/vendors](https://developer.brex.com/openapi/payments_api/vendors/listvendors.md): This endpoint lists all existing vendors for an account.
Takes an optional parameter to match by vendor name.

### Create vendor

 - [POST /v1/vendors](https://developer.brex.com/openapi/payments_api/vendors/createvendor.md): This endpoint creates a new vendor.

### Get vendor

 - [GET /v1/vendors/{id}](https://developer.brex.com/openapi/payments_api/vendors/getvendorbyid.md): This endpoint gets a vendor by ID.

### Update vendor

 - [PUT /v1/vendors/{id}](https://developer.brex.com/openapi/payments_api/vendors/updatevendor.md): Updates an existing vendor by ID.

### Delete vendor.

 - [DELETE /v1/vendors/{id}](https://developer.brex.com/openapi/payments_api/vendors/deletevendor.md): This endpoint deletes a vendor by ID.

## Transfers

Endpoints to initiate transfers and view transfer statuses. Note that for all transfer endpoints, the 'money' field is positive or unsigned for outgoing transfers (debits), and negative for incoming transfers (credits).

### Create incoming transfer

 - [POST /v1/incoming_transfers](https://developer.brex.com/openapi/payments_api/transfers/createincomingtransfer.md): This endpoint creates a new incoming transfer. You may use use any eligible bank account connection to fund (ACH Debit) 
any active Brex business account.

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.

### Lists transfers

 - [GET /v1/transfers](https://developer.brex.com/openapi/payments_api/transfers/listtransfers.md): 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

### Create transfer

 - [POST /v1/transfers](https://developer.brex.com/openapi/payments_api/transfers/createtransfer.md): This endpoint creates a new transfer.

Currently, the API can only create transfers for the following payment rails:
- ACH
- DOMESTIC_WIRE
- CHEQUE
- INTERNATIONAL_WIRES

Transaction Descriptions
* For outgoing check payments, a successful transfer will return a response containing a description value with a format of Check # to  - .
* For book transfers (from one Brex Business account to another), the recipient value will have a format of  -  and the sender will have a format of  - .
* For other payment rails, the format will be  - , 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 
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.

### Get transfer

 - [GET /v1/transfers/{id}](https://developer.brex.com/openapi/payments_api/transfers/gettransfersbyid.md): This endpoint gets a transfer by ID.

Currently, the API can only return transfers for the following payment rails:
- ACH
- DOMESTIC_WIRE
- CHEQUE
- INTERNATIONAL_WIRE

## Linked Accounts

Endpoint to view connected linked accounts

### Lists linked accounts

 - [GET /v1/linked_accounts](https://developer.brex.com/openapi/payments_api/linked-accounts/listlinkedaccounts.md): This endpoint lists all bank connections that are eligible to make ACH transfers to Brex business account