Download OpenAPI specification:Download
The transactions API lets you view your transactions, accounts, and statements.
OAuth2 security scheme
Security Scheme Type | OAuth2 |
---|---|
authorizationCode OAuth Flow | Authorization URL: https://accounts.brex.com/oauth2/v1/auth Token URL: https://accounts.brex.com/oauth2/v1/token Scopes:
|
This endpoint lists all settled transactions for the primary card account.
transactions.card.readonly
) cursor | string or null |
limit | integer or null <int32> |
posted_at_start | string or null <date-time> Shows only transactions with a Example: posted_at_start=
2022-12-12T23:59:59.999
|
listPrimaryCardTransactions 200 response
Bad request
Unauthorized
Forbidden
curl -i -X GET \ https://platform.brexapis.com/v2/transactions/card/primary \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
{- "next_cursor": "string",
- "items": [
- {
- "id": "string",
- "card_id": "string",
- "description": "string",
- "amount": {
- "amount": 0,
- "currency": "string"
}, - "initiated_at_date": "2019-08-24",
- "posted_at_date": "2019-08-24",
- "type": "PURCHASE",
- "merchant": {
- "raw_descriptor": "string",
- "mcc": "string"
}, - "card_metadata": {
- "property1": "string",
- "property2": "string"
}
}
]
}
This endpoint lists all transactions for the cash account with the selected ID.
transactions.cash.readonly
) cursor | string or null |
limit | integer or null <int32> |
posted_at_start | string or null <date-time> Shows only transactions with a Example: posted_at_start=
2022-12-12T23:59:59.999
|
listCashTransactions 200 response
Bad request
Unauthorized
Forbidden
curl -i -X GET \ 'https://platform.brexapis.com/v2/transactions/cash/{id}' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
{- "next_cursor": "string",
- "items": [
- {
- "id": "string",
- "description": "string",
- "amount": {
- "amount": 0,
- "currency": "string"
}, - "initiated_at_date": "2019-08-24",
- "posted_at_date": "2019-08-24",
- "type": "PAYMENT"
}
]
}
This endpoint lists all accounts of card type.
accounts.card.readonly
) listCardAccounts 200 response
Bad request
Unauthorized
Forbidden
curl -i -X GET \ https://platform.brexapis.com/v2/accounts/card \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
[- {
- "id": "string",
- "status": "ACTIVE",
- "current_balance": {
- "amount": 0,
- "currency": "string"
}, - "available_balance": {
- "amount": 0,
- "currency": "string"
}, - "account_limit": {
- "amount": 0,
- "currency": "string"
}, - "current_statement_period": {
- "start_date": "2019-08-24",
- "end_date": "2019-08-24"
}
}
]
This endpoint lists all finalized statements for the primary card account.
statements.card.readonly
) listPrimaryCardStatements 200 response
Bad request
Unauthorized
Forbidden
curl -i -X GET \ https://platform.brexapis.com/v2/accounts/card/primary/statements \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
{- "next_cursor": "string",
- "items": [
- {
- "id": "string",
- "start_balance": {
- "amount": 0,
- "currency": "string"
}, - "end_balance": {
- "amount": 0,
- "currency": "string"
}, - "period": {
- "start_date": "2019-08-24",
- "end_date": "2019-08-24"
}
}
]
}
This endpoint lists all the existing cash accounts with their status.
accounts.cash.readonly
) listAccounts 200 response
Bad request
Unauthorized
Forbidden
curl -i -X GET \ https://platform.brexapis.com/v2/accounts/cash \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
{- "next_cursor": "string",
- "items": [
- {
- "id": "string",
- "name": "string",
- "status": "ACTIVE",
- "current_balance": {
- "amount": 0,
- "currency": "string"
}, - "available_balance": {
- "amount": 0,
- "currency": "string"
}, - "account_number": "string",
- "routing_number": "string",
- "primary": true
}
]
}
This endpoint returns the primary cash account with its status. There will always be only one primary account.
accounts.cash.readonly
) getPrimaryAccount 200 response
Bad request
Unauthorized
Forbidden
curl -i -X GET \ https://platform.brexapis.com/v2/accounts/cash/primary \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
{- "id": "string",
- "name": "string",
- "status": "ACTIVE",
- "current_balance": {
- "amount": 0,
- "currency": "string"
}, - "available_balance": {
- "amount": 0,
- "currency": "string"
}, - "account_number": "string",
- "routing_number": "string",
- "primary": true
}
This endpoint returns the cash account associated with the provided ID with its status.
accounts.cash.readonly
) getAccount 200 response
Bad request
Unauthorized
Forbidden
curl -i -X GET \ 'https://platform.brexapis.com/v2/accounts/cash/{id}' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
{- "id": "string",
- "name": "string",
- "status": "ACTIVE",
- "current_balance": {
- "amount": 0,
- "currency": "string"
}, - "available_balance": {
- "amount": 0,
- "currency": "string"
}, - "account_number": "string",
- "routing_number": "string",
- "primary": true
}
This endpoint lists all finalized statements for the cash account by ID.
statements.cash.readonly
) listCashStatements 200 response
Bad request
Unauthorized
Forbidden
curl -i -X GET \ 'https://platform.brexapis.com/v2/accounts/cash/{id}/statements' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
{- "next_cursor": "string",
- "items": [
- {
- "id": "string",
- "start_balance": {
- "amount": 0,
- "currency": "string"
}, - "end_balance": {
- "amount": 0,
- "currency": "string"
}, - "period": {
- "start_date": "2019-08-24",
- "end_date": "2019-08-24"
}
}
]
}