--- title: PaymentsPaths editUrl: false head: [] template: doc prev: false next: false sidebar: hidden: false attrs: {} pagefind: true draft: false --- Defined in: [src/payments/types.gen.ts:2](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/payments/types.gen.ts#L2) ## Properties ### /v1/incoming\_transfers > **/v1/incoming\_transfers**: `object` Defined in: [src/payments/types.gen.ts:3](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/payments/types.gen.ts#L3) #### delete? > `optional` **delete?**: `undefined` #### get? > `optional` **get?**: `undefined` #### head? > `optional` **head?**: `undefined` #### options? > `optional` **options?**: `undefined` #### parameters > **parameters**: `object` ##### parameters.cookie? > `optional` **cookie?**: `undefined` ##### parameters.header? > `optional` **header?**: `undefined` ##### parameters.path? > `optional` **path?**: `undefined` ##### parameters.query? > `optional` **query?**: `undefined` #### patch? > `optional` **patch?**: `undefined` #### post > **post**: `object` Create incoming transfer ##### Description 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. ##### post.parameters > **parameters**: `object` ##### post.parameters.cookie? > `optional` **cookie?**: `undefined` ##### post.parameters.header > **header**: `object` ##### post.parameters.header.Idempotency-Key > **Idempotency-Key**: `string` ##### post.parameters.path? > `optional` **path?**: `undefined` ##### post.parameters.query? > `optional` **query?**: `undefined` ##### post.requestBody > **requestBody**: `object` ##### post.requestBody.content > **content**: `object` ##### post.requestBody.content.application/json > **application/json**: `object` ##### post.requestBody.content.application/json.amount > **amount**: `object` ##### post.requestBody.content.application/json.amount.amount > **amount**: `number` Format: int64 ###### Description The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents. ###### Example ```ts 700 ``` ##### post.requestBody.content.application/json.amount.currency > **currency**: `string` \| `null` ###### Description The type of currency, in ISO 4217 format. ###### Default ```ts USD ``` ###### Example ```ts USD ``` ##### post.requestBody.content.application/json.counterparty > **counterparty**: `object` & `object` ###### Type Declaration ###### id > **id**: `string` ###### Description The financial account id: Can be found from the [List linked accounts](/openapi/payments_api/#operation/listLinkedAccounts) endpoint ###### type > **type**: `"BANK"` ###### Type Declaration ###### type > **type**: `"BANK"` ###### Description discriminator enum property added by openapi-typescript ##### post.requestBody.content.application/json.description > **description**: `string` ###### Description Description of the transfer for internal use. Not exposed externally. ##### post.requestBody.content.application/json.receiving\_account > **receiving\_account**: `object` & `object` ###### Type Declaration ###### id > **id**: `string` ###### Description ID of the Brex business account: Can be found from the [List business accounts](/openapi/transactions_api/#operation/listAccounts) endpoint ###### type > **type**: `"BREX_CASH"` ###### Type Declaration ###### type > **type**: `"BREX_CASH"` ###### Description discriminator enum property added by openapi-typescript ##### post.responses > **responses**: `object` ##### post.responses.200 > **200**: `object` ###### Description createIncomingTransfer 200 response ##### post.responses.200.content > **content**: `object` ##### post.responses.200.content.application/json > **application/json**: `object` ##### post.responses.200.content.application/json.amount > **amount**: `object` ##### post.responses.200.content.application/json.amount.amount > **amount**: `number` Format: int64 ###### Description The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents. ###### Example ```ts 700 ``` ##### post.responses.200.content.application/json.amount.currency > **currency**: `string` \| `null` ###### Description The type of currency, in ISO 4217 format. ###### Default ```ts USD ``` ###### Example ```ts USD ``` ##### post.responses.200.content.application/json.cancellation\_reason? > `optional` **cancellation\_reason?**: `"USER_CANCELLED"` \| `"INSUFFICIENT_FUNDS"` \| `"APPROVAL_DENIED"` \| `"BLOCKED_BY_POSITIVE_PAY"` \| `null` ##### post.responses.200.content.application/json.counterparty? > `optional` **counterparty?**: `Omit`\<`object` & `object`, `"type"`\> \| `null` ##### post.responses.200.content.application/json.created\_at? > `optional` **created\_at?**: `string` \| `null` Format: date ###### Description Date of transfer creation ##### post.responses.200.content.application/json.creator\_user\_id? > `optional` **creator\_user\_id?**: `string` \| `null` ###### Description User ID of the transfer initiator ##### post.responses.200.content.application/json.description? > `optional` **description?**: `string` \| `null` ###### Description Description of the transfer ##### post.responses.200.content.application/json.display\_name? > `optional` **display\_name?**: `string` \| `null` ###### Description Human readable name for the transaction ##### post.responses.200.content.application/json.estimated\_delivery\_date? > `optional` **estimated\_delivery\_date?**: `string` \| `null` Format: date ###### Description Estimated delivery date for transfer ##### post.responses.200.content.application/json.external\_memo? > `optional` **external\_memo?**: `string` \| `null` ###### Description 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` ##### post.responses.200.content.application/json.id > **id**: `string` ###### Description Unique ID associated with the transfer ##### post.responses.200.content.application/json.is\_ppro\_enabled? > `optional` **is\_ppro\_enabled?**: `boolean` \| `null` ###### Description If Principal Protection (PPRO) is enabled ##### post.responses.200.content.application/json.originating\_account > **originating\_account**: `object` & `object` ###### Type Declaration ###### id > **id**: `string` ###### Description ID of the Brex Business account. ###### type > **type**: `"BREX_CASH"` ###### Type Declaration ###### type > **type**: `"BREX_CASH"` ###### Description discriminator enum property added by openapi-typescript ##### post.responses.200.content.application/json.payment\_type > **payment\_type**: `"ACH"` \| `"DOMESTIC_WIRE"` \| `"CHEQUE"` \| `"INTERNATIONAL_WIRE"` \| `"BOOK_TRANSFER"` \| `"STABLECOIN"` ##### post.responses.200.content.application/json.process\_date? > `optional` **process\_date?**: `string` \| `null` Format: date ###### Description Transaction processing date ##### post.responses.200.content.application/json.status > **status**: `"PROCESSING"` \| `"SCHEDULED"` \| `"PENDING_APPROVAL"` \| `"FAILED"` \| `"PROCESSED"` ##### post.responses.200.headers > **headers**: `object` ###### Index Signature \[`name`: `string`\]: `unknown` #### put? > `optional` **put?**: `undefined` #### trace? > `optional` **trace?**: `undefined` *** ### /v1/linked\_accounts > **/v1/linked\_accounts**: `object` Defined in: [src/payments/types.gen.ts:31](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/payments/types.gen.ts#L31) #### delete? > `optional` **delete?**: `undefined` #### get > **get**: `object` Lists linked accounts ##### Description This endpoint lists all bank connections that are eligible to make ACH transfers to Brex business account ##### get.parameters > **parameters**: `object` ##### get.parameters.cookie? > `optional` **cookie?**: `undefined` ##### get.parameters.header? > `optional` **header?**: `undefined` ##### get.parameters.path? > `optional` **path?**: `undefined` ##### get.parameters.query? > `optional` **query?**: `object` ##### get.parameters.query.cursor? > `optional` **cursor?**: `string` \| `null` ##### get.parameters.query.limit? > `optional` **limit?**: `number` \| `null` ##### get.requestBody? > `optional` **requestBody?**: `undefined` ##### get.responses > **responses**: `object` ##### get.responses.200 > **200**: `object` ###### Description Returns a list of bank connections ##### get.responses.200.content > **content**: `object` ##### get.responses.200.content.application/json > **application/json**: `object` ##### get.responses.200.content.application/json.items > **items**: `object`[] ##### get.responses.200.content.application/json.next\_cursor? > `optional` **next\_cursor?**: `string` \| `null` ##### get.responses.200.headers > **headers**: `object` ###### Index Signature \[`name`: `string`\]: `unknown` ##### get.responses.400 > **400**: `object` ###### Description Bad request ##### get.responses.400.content? > `optional` **content?**: `undefined` ##### get.responses.400.headers > **headers**: `object` ###### Index Signature \[`name`: `string`\]: `unknown` ##### get.responses.401 > **401**: `object` ###### Description Unauthorized ##### get.responses.401.content? > `optional` **content?**: `undefined` ##### get.responses.401.headers > **headers**: `object` ###### Index Signature \[`name`: `string`\]: `unknown` ##### get.responses.403 > **403**: `object` ###### Description Forbidden ##### get.responses.403.content? > `optional` **content?**: `undefined` ##### get.responses.403.headers > **headers**: `object` ###### Index Signature \[`name`: `string`\]: `unknown` #### head? > `optional` **head?**: `undefined` #### options? > `optional` **options?**: `undefined` #### parameters > **parameters**: `object` ##### parameters.cookie? > `optional` **cookie?**: `undefined` ##### parameters.header? > `optional` **header?**: `undefined` ##### parameters.path? > `optional` **path?**: `undefined` ##### parameters.query? > `optional` **query?**: `undefined` #### patch? > `optional` **patch?**: `undefined` #### post? > `optional` **post?**: `undefined` #### put? > `optional` **put?**: `undefined` #### trace? > `optional` **trace?**: `undefined` *** ### /v1/transfers > **/v1/transfers**: `object` Defined in: [src/payments/types.gen.ts:51](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/payments/types.gen.ts#L51) #### delete? > `optional` **delete?**: `undefined` #### get > **get**: `object` Lists transfers ##### Description 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 ##### get.parameters > **parameters**: `object` ##### get.parameters.cookie? > `optional` **cookie?**: `undefined` ##### get.parameters.header? > `optional` **header?**: `undefined` ##### get.parameters.path? > `optional` **path?**: `undefined` ##### get.parameters.query? > `optional` **query?**: `object` ##### get.parameters.query.cursor? > `optional` **cursor?**: `string` \| `null` ##### get.parameters.query.limit? > `optional` **limit?**: `number` \| `null` ##### get.requestBody? > `optional` **requestBody?**: `undefined` ##### get.responses > **responses**: `object` ##### get.responses.200 > **200**: `object` ###### Description Returns a list of transfers. ##### get.responses.200.content > **content**: `object` ##### get.responses.200.content.application/json > **application/json**: `object` ##### get.responses.200.content.application/json.items > **items**: `object`[] ##### get.responses.200.content.application/json.next\_cursor? > `optional` **next\_cursor?**: `string` \| `null` ##### get.responses.200.headers > **headers**: `object` ###### Index Signature \[`name`: `string`\]: `unknown` ##### get.responses.400 > **400**: `object` ###### Description Bad request ##### get.responses.400.content? > `optional` **content?**: `undefined` ##### get.responses.400.headers > **headers**: `object` ###### Index Signature \[`name`: `string`\]: `unknown` ##### get.responses.401 > **401**: `object` ###### Description Unauthorized ##### get.responses.401.content? > `optional` **content?**: `undefined` ##### get.responses.401.headers > **headers**: `object` ###### Index Signature \[`name`: `string`\]: `unknown` ##### get.responses.403 > **403**: `object` ###### Description Forbidden ##### get.responses.403.content? > `optional` **content?**: `undefined` ##### get.responses.403.headers > **headers**: `object` ###### Index Signature \[`name`: `string`\]: `unknown` ##### get.responses.500 > **500**: `object` ###### Description Internal server error ##### get.responses.500.content? > `optional` **content?**: `undefined` ##### get.responses.500.headers > **headers**: `object` ###### Index Signature \[`name`: `string`\]: `unknown` #### head? > `optional` **head?**: `undefined` #### options? > `optional` **options?**: `undefined` #### parameters > **parameters**: `object` ##### parameters.cookie? > `optional` **cookie?**: `undefined` ##### parameters.header? > `optional` **header?**: `undefined` ##### parameters.path? > `optional` **path?**: `undefined` ##### parameters.query? > `optional` **query?**: `undefined` #### patch? > `optional` **patch?**: `undefined` #### post > **post**: `object` Create transfer ##### Description 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](/openapi/payments_api/#operation/createVendor!path=company_name&t=request). **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. ##### post.parameters > **parameters**: `object` ##### post.parameters.cookie? > `optional` **cookie?**: `undefined` ##### post.parameters.header > **header**: `object` ##### post.parameters.header.Idempotency-Key > **Idempotency-Key**: `string` ##### post.parameters.path? > `optional` **path?**: `undefined` ##### post.parameters.query? > `optional` **query?**: `undefined` ##### post.requestBody > **requestBody**: `object` ##### post.requestBody.content > **content**: `object` ##### post.requestBody.content.application/json > **application/json**: `object` ##### post.requestBody.content.application/json.amount > **amount**: `object` ##### post.requestBody.content.application/json.amount.amount > **amount**: `number` Format: int64 ###### Description The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents. ###### Example ```ts 700 ``` ##### post.requestBody.content.application/json.amount.currency > **currency**: `string` \| `null` ###### Description The type of currency, in ISO 4217 format. ###### Default ```ts USD ``` ###### Example ```ts USD ``` ##### post.requestBody.content.application/json.approval\_type? > `optional` **approval\_type?**: `"MANUAL"` \| `null` ##### post.requestBody.content.application/json.counterparty > **counterparty**: `object` & `object` \| `object` & `object` ##### post.requestBody.content.application/json.description > **description**: `string` ###### Description Description of the transfer for internal use. Not exposed externally. ##### post.requestBody.content.application/json.external\_memo > **external\_memo**: `string` ###### Description 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` ##### post.requestBody.content.application/json.is\_ppro\_enabled? > `optional` **is\_ppro\_enabled?**: `boolean` ###### Description 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. ##### post.requestBody.content.application/json.originating\_account > **originating\_account**: `Omit`\<`object` & `object`, `"type"`\> ##### post.responses > **responses**: `object` ##### post.responses.200 > **200**: `object` ###### Description createTransfer 200 response ##### post.responses.200.content > **content**: `object` ##### post.responses.200.content.application/json > **application/json**: `object` ##### post.responses.200.content.application/json.amount > **amount**: `object` ##### post.responses.200.content.application/json.amount.amount > **amount**: `number` Format: int64 ###### Description The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents. ###### Example ```ts 700 ``` ##### post.responses.200.content.application/json.amount.currency > **currency**: `string` \| `null` ###### Description The type of currency, in ISO 4217 format. ###### Default ```ts USD ``` ###### Example ```ts USD ``` ##### post.responses.200.content.application/json.cancellation\_reason? > `optional` **cancellation\_reason?**: `"USER_CANCELLED"` \| `"INSUFFICIENT_FUNDS"` \| `"APPROVAL_DENIED"` \| `"BLOCKED_BY_POSITIVE_PAY"` \| `null` ##### post.responses.200.content.application/json.counterparty? > `optional` **counterparty?**: `Omit`\<`object` & `object`, `"type"`\> \| `null` ##### post.responses.200.content.application/json.created\_at? > `optional` **created\_at?**: `string` \| `null` Format: date ###### Description Date of transfer creation ##### post.responses.200.content.application/json.creator\_user\_id? > `optional` **creator\_user\_id?**: `string` \| `null` ###### Description User ID of the transfer initiator ##### post.responses.200.content.application/json.description? > `optional` **description?**: `string` \| `null` ###### Description Description of the transfer ##### post.responses.200.content.application/json.display\_name? > `optional` **display\_name?**: `string` \| `null` ###### Description Human readable name for the transaction ##### post.responses.200.content.application/json.estimated\_delivery\_date? > `optional` **estimated\_delivery\_date?**: `string` \| `null` Format: date ###### Description Estimated delivery date for transfer ##### post.responses.200.content.application/json.external\_memo? > `optional` **external\_memo?**: `string` \| `null` ###### Description 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` ##### post.responses.200.content.application/json.id > **id**: `string` ###### Description Unique ID associated with the transfer ##### post.responses.200.content.application/json.is\_ppro\_enabled? > `optional` **is\_ppro\_enabled?**: `boolean` \| `null` ###### Description If Principal Protection (PPRO) is enabled ##### post.responses.200.content.application/json.originating\_account > **originating\_account**: `object` & `object` ###### Type Declaration ###### id > **id**: `string` ###### Description ID of the Brex Business account. ###### type > **type**: `"BREX_CASH"` ###### Type Declaration ###### type > **type**: `"BREX_CASH"` ###### Description discriminator enum property added by openapi-typescript ##### post.responses.200.content.application/json.payment\_type > **payment\_type**: `"ACH"` \| `"DOMESTIC_WIRE"` \| `"CHEQUE"` \| `"INTERNATIONAL_WIRE"` \| `"BOOK_TRANSFER"` \| `"STABLECOIN"` ##### post.responses.200.content.application/json.process\_date? > `optional` **process\_date?**: `string` \| `null` Format: date ###### Description Transaction processing date ##### post.responses.200.content.application/json.status > **status**: `"PROCESSING"` \| `"SCHEDULED"` \| `"PENDING_APPROVAL"` \| `"FAILED"` \| `"PROCESSED"` ##### post.responses.200.headers > **headers**: `object` ###### Index Signature \[`name`: `string`\]: `unknown` #### put? > `optional` **put?**: `undefined` #### trace? > `optional` **trace?**: `undefined` *** ### /v1/transfers/\{id\} > **/v1/transfers/\{id\}**: `object` Defined in: [src/payments/types.gen.ts:100](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/payments/types.gen.ts#L100) #### delete? > `optional` **delete?**: `undefined` #### get > **get**: `object` Get transfer ##### Description 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 ##### get.parameters > **parameters**: `object` ##### get.parameters.cookie? > `optional` **cookie?**: `undefined` ##### get.parameters.header? > `optional` **header?**: `undefined` ##### get.parameters.path > **path**: `object` ##### get.parameters.path.id > **id**: `string` ##### get.parameters.query? > `optional` **query?**: `undefined` ##### get.requestBody? > `optional` **requestBody?**: `undefined` ##### get.responses > **responses**: `object` ##### get.responses.200 > **200**: `object` ###### Description Returns a transfer. ##### get.responses.200.content > **content**: `object` ##### get.responses.200.content.application/json > **application/json**: `object` ##### get.responses.200.content.application/json.amount > **amount**: `object` ##### get.responses.200.content.application/json.amount.amount > **amount**: `number` Format: int64 ###### Description The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents. ###### Example ```ts 700 ``` ##### get.responses.200.content.application/json.amount.currency > **currency**: `string` \| `null` ###### Description The type of currency, in ISO 4217 format. ###### Default ```ts USD ``` ###### Example ```ts USD ``` ##### get.responses.200.content.application/json.cancellation\_reason? > `optional` **cancellation\_reason?**: `"USER_CANCELLED"` \| `"INSUFFICIENT_FUNDS"` \| `"APPROVAL_DENIED"` \| `"BLOCKED_BY_POSITIVE_PAY"` \| `null` ##### get.responses.200.content.application/json.counterparty? > `optional` **counterparty?**: `Omit`\<`object` & `object`, `"type"`\> \| `null` ##### get.responses.200.content.application/json.created\_at? > `optional` **created\_at?**: `string` \| `null` Format: date ###### Description Date of transfer creation ##### get.responses.200.content.application/json.creator\_user\_id? > `optional` **creator\_user\_id?**: `string` \| `null` ###### Description User ID of the transfer initiator ##### get.responses.200.content.application/json.description? > `optional` **description?**: `string` \| `null` ###### Description Description of the transfer ##### get.responses.200.content.application/json.display\_name? > `optional` **display\_name?**: `string` \| `null` ###### Description Human readable name for the transaction ##### get.responses.200.content.application/json.estimated\_delivery\_date? > `optional` **estimated\_delivery\_date?**: `string` \| `null` Format: date ###### Description Estimated delivery date for transfer ##### get.responses.200.content.application/json.external\_memo? > `optional` **external\_memo?**: `string` \| `null` ###### Description 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` ##### get.responses.200.content.application/json.id > **id**: `string` ###### Description Unique ID associated with the transfer ##### get.responses.200.content.application/json.is\_ppro\_enabled? > `optional` **is\_ppro\_enabled?**: `boolean` \| `null` ###### Description If Principal Protection (PPRO) is enabled ##### get.responses.200.content.application/json.originating\_account > **originating\_account**: `object` & `object` ###### Type Declaration ###### id > **id**: `string` ###### Description ID of the Brex Business account. ###### type > **type**: `"BREX_CASH"` ###### Type Declaration ###### type > **type**: `"BREX_CASH"` ###### Description discriminator enum property added by openapi-typescript ##### get.responses.200.content.application/json.payment\_type > **payment\_type**: `"ACH"` \| `"DOMESTIC_WIRE"` \| `"CHEQUE"` \| `"INTERNATIONAL_WIRE"` \| `"BOOK_TRANSFER"` \| `"STABLECOIN"` ##### get.responses.200.content.application/json.process\_date? > `optional` **process\_date?**: `string` \| `null` Format: date ###### Description Transaction processing date ##### get.responses.200.content.application/json.status > **status**: `"PROCESSING"` \| `"SCHEDULED"` \| `"PENDING_APPROVAL"` \| `"FAILED"` \| `"PROCESSED"` ##### get.responses.200.headers > **headers**: `object` ###### Index Signature \[`name`: `string`\]: `unknown` ##### get.responses.400 > **400**: `object` ###### Description Bad request ##### get.responses.400.content? > `optional` **content?**: `undefined` ##### get.responses.400.headers > **headers**: `object` ###### Index Signature \[`name`: `string`\]: `unknown` ##### get.responses.401 > **401**: `object` ###### Description Unauthorized ##### get.responses.401.content? > `optional` **content?**: `undefined` ##### get.responses.401.headers > **headers**: `object` ###### Index Signature \[`name`: `string`\]: `unknown` ##### get.responses.403 > **403**: `object` ###### Description Forbidden ##### get.responses.403.content? > `optional` **content?**: `undefined` ##### get.responses.403.headers > **headers**: `object` ###### Index Signature \[`name`: `string`\]: `unknown` ##### get.responses.500 > **500**: `object` ###### Description Internal server error ##### get.responses.500.content? > `optional` **content?**: `undefined` ##### get.responses.500.headers > **headers**: `object` ###### Index Signature \[`name`: `string`\]: `unknown` #### head? > `optional` **head?**: `undefined` #### options? > `optional` **options?**: `undefined` #### parameters > **parameters**: `object` ##### parameters.cookie? > `optional` **cookie?**: `undefined` ##### parameters.header? > `optional` **header?**: `undefined` ##### parameters.path? > `optional` **path?**: `undefined` ##### parameters.query? > `optional` **query?**: `undefined` #### patch? > `optional` **patch?**: `undefined` #### post? > `optional` **post?**: `undefined` #### put? > `optional` **put?**: `undefined` #### trace? > `optional` **trace?**: `undefined` *** ### /v1/vendors > **/v1/vendors**: `object` Defined in: [src/payments/types.gen.ts:126](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/payments/types.gen.ts#L126) #### delete? > `optional` **delete?**: `undefined` #### get > **get**: `object` Lists vendors ##### Description This endpoint lists all existing vendors for an account. Takes an optional parameter to match by vendor name. ##### get.parameters > **parameters**: `object` ##### get.parameters.cookie? > `optional` **cookie?**: `undefined` ##### get.parameters.header? > `optional` **header?**: `undefined` ##### get.parameters.path? > `optional` **path?**: `undefined` ##### get.parameters.query? > `optional` **query?**: `object` ##### get.parameters.query.cursor? > `optional` **cursor?**: `string` \| `null` ##### get.parameters.query.limit? > `optional` **limit?**: `number` \| `null` ##### get.parameters.query.name? > `optional` **name?**: `string` \| `null` ##### get.requestBody? > `optional` **requestBody?**: `undefined` ##### get.responses > **responses**: `object` ##### get.responses.200 > **200**: `object` ###### Description Returns a list of vendor objects. ##### get.responses.200.content > **content**: `object` ##### get.responses.200.content.application/json > **application/json**: `object` ##### get.responses.200.content.application/json.items > **items**: `object`[] ##### get.responses.200.content.application/json.next\_cursor? > `optional` **next\_cursor?**: `string` \| `null` ##### get.responses.200.headers > **headers**: `object` ###### Index Signature \[`name`: `string`\]: `unknown` ##### get.responses.400 > **400**: `object` ###### Description Bad request ##### get.responses.400.content? > `optional` **content?**: `undefined` ##### get.responses.400.headers > **headers**: `object` ###### Index Signature \[`name`: `string`\]: `unknown` ##### get.responses.401 > **401**: `object` ###### Description Unauthorized ##### get.responses.401.content? > `optional` **content?**: `undefined` ##### get.responses.401.headers > **headers**: `object` ###### Index Signature \[`name`: `string`\]: `unknown` ##### get.responses.403 > **403**: `object` ###### Description Forbidden ##### get.responses.403.content? > `optional` **content?**: `undefined` ##### get.responses.403.headers > **headers**: `object` ###### Index Signature \[`name`: `string`\]: `unknown` #### head? > `optional` **head?**: `undefined` #### options? > `optional` **options?**: `undefined` #### parameters > **parameters**: `object` ##### parameters.cookie? > `optional` **cookie?**: `undefined` ##### parameters.header? > `optional` **header?**: `undefined` ##### parameters.path? > `optional` **path?**: `undefined` ##### parameters.query? > `optional` **query?**: `undefined` #### patch? > `optional` **patch?**: `undefined` #### post > **post**: `object` Create vendor ##### Description This endpoint creates a new vendor. ##### post.parameters > **parameters**: `object` ##### post.parameters.cookie? > `optional` **cookie?**: `undefined` ##### post.parameters.header > **header**: `object` ##### post.parameters.header.Idempotency-Key > **Idempotency-Key**: `string` ##### post.parameters.path? > `optional` **path?**: `undefined` ##### post.parameters.query? > `optional` **query?**: `undefined` ##### post.requestBody > **requestBody**: `object` ##### post.requestBody.content > **content**: `object` ##### post.requestBody.content.application/json > **application/json**: `object` ##### post.requestBody.content.application/json.company\_name > **company\_name**: `string` ###### Description Name for vendor. The name must be unique. ##### post.requestBody.content.application/json.email? > `optional` **email?**: `string` \| `null` Format: email ###### Description Email for vendor. ##### post.requestBody.content.application/json.payment\_accounts? > `optional` **payment\_accounts?**: `object`[] \| `null` ###### Description Payment accounts associated with the vendor. ##### post.requestBody.content.application/json.phone? > `optional` **phone?**: `string` \| `null` ###### Description Phone number for vendor. ##### post.responses > **responses**: `object` ##### post.responses.200 > **200**: `object` ###### Description createVendor 200 response ##### post.responses.200.content > **content**: `object` ##### post.responses.200.content.application/json > **application/json**: `object` ##### post.responses.200.content.application/json.company\_name? > `optional` **company\_name?**: `string` \| `null` ##### post.responses.200.content.application/json.email? > `optional` **email?**: `string` \| `null` ##### post.responses.200.content.application/json.id > **id**: `string` ###### Description Vendor ID: Can be passed to /transfers endpoint to specify counterparty. ##### post.responses.200.content.application/json.payment\_accounts? > `optional` **payment\_accounts?**: `object`[] \| `null` ##### post.responses.200.content.application/json.phone? > `optional` **phone?**: `string` \| `null` ##### post.responses.200.headers > **headers**: `object` ###### Index Signature \[`name`: `string`\]: `unknown` #### put? > `optional` **put?**: `undefined` #### trace? > `optional` **trace?**: `undefined` *** ### /v1/vendors/\{id\} > **/v1/vendors/\{id\}**: `object` Defined in: [src/payments/types.gen.ts:151](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/payments/types.gen.ts#L151) #### delete > **delete**: `object` Delete vendor. ##### Description This endpoint deletes a vendor by ID. ##### delete.parameters > **parameters**: `object` ##### delete.parameters.cookie? > `optional` **cookie?**: `undefined` ##### delete.parameters.header? > `optional` **header?**: `undefined` ##### delete.parameters.path > **path**: `object` ##### delete.parameters.path.id > **id**: `string` ##### delete.parameters.query? > `optional` **query?**: `undefined` ##### delete.requestBody? > `optional` **requestBody?**: `undefined` ##### delete.responses > **responses**: `object` ##### delete.responses.200 > **200**: `object` ###### Description deleteVendor 200 response ##### delete.responses.200.content? > `optional` **content?**: `undefined` ##### delete.responses.200.headers > **headers**: `object` ###### Index Signature \[`name`: `string`\]: `unknown` #### get > **get**: `object` Get vendor ##### Description This endpoint gets a vendor by ID. ##### get.parameters > **parameters**: `object` ##### get.parameters.cookie? > `optional` **cookie?**: `undefined` ##### get.parameters.header? > `optional` **header?**: `undefined` ##### get.parameters.path > **path**: `object` ##### get.parameters.path.id > **id**: `string` ##### get.parameters.query? > `optional` **query?**: `undefined` ##### get.requestBody? > `optional` **requestBody?**: `undefined` ##### get.responses > **responses**: `object` ##### get.responses.200 > **200**: `object` ###### Description Returns a vendor object. ##### get.responses.200.content > **content**: `object` ##### get.responses.200.content.application/json > **application/json**: `object` ##### get.responses.200.content.application/json.company\_name? > `optional` **company\_name?**: `string` \| `null` ##### get.responses.200.content.application/json.email? > `optional` **email?**: `string` \| `null` ##### get.responses.200.content.application/json.id > **id**: `string` ###### Description Vendor ID: Can be passed to /transfers endpoint to specify counterparty. ##### get.responses.200.content.application/json.payment\_accounts? > `optional` **payment\_accounts?**: `object`[] \| `null` ##### get.responses.200.content.application/json.phone? > `optional` **phone?**: `string` \| `null` ##### get.responses.200.headers > **headers**: `object` ###### Index Signature \[`name`: `string`\]: `unknown` ##### get.responses.400 > **400**: `object` ###### Description Bad request ##### get.responses.400.content? > `optional` **content?**: `undefined` ##### get.responses.400.headers > **headers**: `object` ###### Index Signature \[`name`: `string`\]: `unknown` ##### get.responses.401 > **401**: `object` ###### Description Unauthorized ##### get.responses.401.content? > `optional` **content?**: `undefined` ##### get.responses.401.headers > **headers**: `object` ###### Index Signature \[`name`: `string`\]: `unknown` ##### get.responses.403 > **403**: `object` ###### Description Forbidden ##### get.responses.403.content? > `optional` **content?**: `undefined` ##### get.responses.403.headers > **headers**: `object` ###### Index Signature \[`name`: `string`\]: `unknown` ##### get.responses.500 > **500**: `object` ###### Description Internal server error ##### get.responses.500.content? > `optional` **content?**: `undefined` ##### get.responses.500.headers > **headers**: `object` ###### Index Signature \[`name`: `string`\]: `unknown` #### head? > `optional` **head?**: `undefined` #### options? > `optional` **options?**: `undefined` #### parameters > **parameters**: `object` ##### parameters.cookie? > `optional` **cookie?**: `undefined` ##### parameters.header? > `optional` **header?**: `undefined` ##### parameters.path? > `optional` **path?**: `undefined` ##### parameters.query? > `optional` **query?**: `undefined` #### patch? > `optional` **patch?**: `undefined` #### post? > `optional` **post?**: `undefined` #### put > **put**: `object` Update vendor ##### Description Updates an existing vendor by ID. ##### put.parameters > **parameters**: `object` ##### put.parameters.cookie? > `optional` **cookie?**: `undefined` ##### put.parameters.header? > `optional` **header?**: `object` ##### put.parameters.header.Idempotency-Key? > `optional` **Idempotency-Key?**: `string` \| `null` ##### put.parameters.path > **path**: `object` ##### put.parameters.path.id > **id**: `string` ##### put.parameters.query? > `optional` **query?**: `undefined` ##### put.requestBody > **requestBody**: `object` ##### put.requestBody.content > **content**: `object` ##### put.requestBody.content.application/json > **application/json**: `object` ##### put.requestBody.content.application/json.beneficiary\_name? > `optional` **beneficiary\_name?**: `string` \| `null` ###### Description Name for the Beneficiary ##### put.requestBody.content.application/json.company\_name? > `optional` **company\_name?**: `string` \| `null` ###### Description Name for vendor ##### put.requestBody.content.application/json.email? > `optional` **email?**: `string` \| `null` Format: email ###### Description Email for vendor ##### put.requestBody.content.application/json.payment\_accounts? > `optional` **payment\_accounts?**: `object`[] \| `null` ###### Description To update payment instruments, we require the entire payload for each payment instrument that is being updated. ##### put.requestBody.content.application/json.phone? > `optional` **phone?**: `string` \| `null` ###### Description Phone number for vendor ##### put.responses > **responses**: `object` ##### put.responses.200 > **200**: `object` ###### Description updateVendor 200 response ##### put.responses.200.content > **content**: `object` ##### put.responses.200.content.application/json > **application/json**: `object` ##### put.responses.200.content.application/json.company\_name? > `optional` **company\_name?**: `string` \| `null` ##### put.responses.200.content.application/json.email? > `optional` **email?**: `string` \| `null` ##### put.responses.200.content.application/json.id > **id**: `string` ###### Description Vendor ID: Can be passed to /transfers endpoint to specify counterparty. ##### put.responses.200.content.application/json.payment\_accounts? > `optional` **payment\_accounts?**: `object`[] \| `null` ##### put.responses.200.content.application/json.phone? > `optional` **phone?**: `string` \| `null` ##### put.responses.200.headers > **headers**: `object` ###### Index Signature \[`name`: `string`\]: `unknown` #### trace? > `optional` **trace?**: `undefined`