Every API here is available over the APIs.io API and to AI agents over MCP.
openapi: 3.1.0
info:
version: '2.4.0'
# build: '0'
title: Personal and Small Business Account Transactions
description: Truist Financial, modeled after FDX V5.4.1 Core API (except Transaction pagination)
contact:
name: Truist API Support
url: 'https://developer.truist.com/contact-us'
x-fdx-csdf-account-categories: [ANY]
servers:
- url: 'https://api-sandbox.truist.com/retail'
description: Truist Financial Retail Open Banking APIs - Sandbox environment
- url: 'https://apicert-secure.truist.com/retail'
description: Truist Financial Retail Open Banking APIs - Certification environment
- url: 'https://api-secure.truist.com/retail'
description: Truist Financial Retail Open Banking APIs - Production environment
security:
- OAuth: [TRANSACTIONS]
tags:
- name: Account Transactions
description: Search and view account transactions
paths:
############################################################
#
# Core paths
#
############################################################
/v2/accounts/{accountId}/transactions:
parameters:
- $ref: '#/components/parameters/FapiInteractionIdHeader'
- $ref: '#/components/parameters/FdxApiActorTypeHeader'
x-fdx-csdf-account-categories: [ANY]
get:
operationId: searchForAccountTransactions
tags:
- Account Transactions
description: >-
Search for account transactions. Example:
/v1/accounts/{accountId}/transactions?startTime=value1&endTime=value2
summary: Search for account transactions
x-fdx-csdf-account-categories: [ANY]
parameters:
- $ref: '#/components/parameters/AccountIdPath'
- $ref: '#/components/parameters/StartTimeQuery'
- $ref: '#/components/parameters/EndTimeQuery'
- $ref: '#/components/parameters/OffSetQuery'
responses:
'200':
description: >-
List of transactions, which can be one of
DepositTransaction, LoanTransaction or LocTransaction
headers:
x-fapi-interaction-id:
$ref: '#/components/headers/x-fapi-interaction-id'
content:
application/json:
schema:
$ref: '#/components/schemas/Transactions'
examples:
DDA Checking Partial Paginated Response:
value:
paginatedArray:
page:
nextOffset: MjAyNC0wMS0wMXwyMDI1LTA1LTA1fE58bnVsbHw1MA==
partialElements: 4
links:
next:
href: >-
/accounts/edLy3Kqu1PwccumVJlV6dyC8034J0SMkASO/transactions?offset=MjAyNC0wMS0wMXwyMDI1LTA1LTA1fE58bnVsbHw1MA==
action: GET
transactions:
- depositTransaction:
accountId: uYrD4LD7P9948lzy3UCPHLWljGqcRWx06Tr
accountCategory: DEPOSIT_ACCOUNT
referenceTransactionId: '220728255690288'
transactionTimestamp: '2022-07-28T13:15:17.000Z'
description: CREDIT LINE ADVANCE-CREDIT LINE ADVANCE-0001111111111 03-21-22
debitCreditMemo: CREDIT
status: PENDING
amount: 1.00
- depositTransaction:
accountId: uYrD4LD7P9948lzy3UCPHLWljGqcRWx06Tr
accountCategory: DEPOSIT_ACCOUNT
referenceTransactionId: '220726389652470'
transactionTimestamp: '2022-07-28T13:47:33.000Z'
description: DEPOSIT TRANSFER-TRANSFER TO CHECKING-0002222222222 03-21-22
debitCreditMemo: DEBIT
status: PENDING
amount: 10.00
- depositTransaction:
accountId: uYrD4LD7P9948lzy3UCPHLWljGqcRWx06Tr
accountCategory: DEPOSIT_ACCOUNT
transactionId: '2024495498'
postedTimestamp: '2022-07-22T00:00:00.000Z'
description: INTEREST PAYMENT
debitCreditMemo: CREDIT
reference: '55487'
status: POSTED
amount: 0.01
transactionType: INTEREST
- depositTransaction:
accountId: p0VLBm0CDZ1HafHSX3jCQXOu32cnEeMZY8j
accountCategory: DEPOSIT_ACCOUNT
transactionId: '5645623838'
postedTimestamp: '2023-07-17T00:00:00.000Z'
description: CHECK
debitCreditMemo: DEBIT
reference: '6965702293'
status: POSTED
amount: 1764.99
transactionType: CHECK
checkNumber: 3059
DDA Checking Paginated Full Response:
value:
paginatedArray:
page:
totalElements: 4
transactions:
- depositTransaction:
accountId: uYrD4LD7P9948lzy3UCPHLWljGqcRWx06Tr
accountCategory: DEPOSIT_ACCOUNT
referenceTransactionId: '220728255690288'
transactionTimestamp: '2022-07-28T13:15:17.000Z'
description: CREDIT LINE ADVANCE-CREDIT LINE ADVANCE-0001111111111 03-21-22
debitCreditMemo: CREDIT
status: PENDING
amount: 1.00
- depositTransaction:
accountId: uYrD4LD7P9948lzy3UCPHLWljGqcRWx06Tr
accountCategory: DEPOSIT_ACCOUNT
referenceTransactionId: '220726389652470'
transactionTimestamp: '2022-07-28T13:47:33.000Z'
description: DEPOSIT TRANSFER-TRANSFER TO CHECKING-0002222222222 03-21-22
debitCreditMemo: DEBIT
status: PENDING
amount: 10.00
- depositTransaction:
accountId: uYrD4LD7P9948lzy3UCPHLWljGqcRWx06Tr
accountCategory: DEPOSIT_ACCOUNT
transactionId: '2024495498'
postedTimestamp: '2022-07-22T00:00:00.000Z'
description: INTEREST PAYMENT
debitCreditMemo: CREDIT
reference: '55487'
status: POSTED
amount: 0.01
transactionType: INTEREST
- depositTransaction:
accountId: p0VLBm0CDZ1HafHSX3jCQXOu32cnEeMZY8j
accountCategory: DEPOSIT_ACCOUNT
transactionId: '5645623838'
postedTimestamp: '2023-07-17T00:00:00.000Z'
description: CHECK
debitCreditMemo: DEBIT
reference: '6965702293'
status: POSTED
amount: 1764.99
transactionType: CHECK
checkNumber: 3059
Savings Paginated Full Response:
value:
paginatedArray:
page:
totalElements: 3
transactions:
- depositTransaction:
accountId: CD69feLdRMb8EskxYG2KepL4XLiSnOFRyyT
accountCategory: DEPOSIT_ACCOUNT
referenceTransactionId: '220729795587959'
transactionTimestamp: '2022-07-28T13:46:24.000Z'
description: DEPOSIT TRANSFER-TRANSFER FROM MONEYACCOUNT-0707070707070707 03-21-22
debitCreditMemo: CREDIT
status: PENDING
amount: 1.00
- depositTransaction:
accountId: CD69feLdRMb8EskxYG2KepL4XLiSnOFRyyT
accountCategory: DEPOSIT_ACCOUNT
transactionId: '1376160555'
postedTimestamp: '2022-07-22T00:00:00.000Z'
description: TRANSFER FROM MONEYACCOUNT ************1111 03-01-22 DEPOSIT TRANSFER
debitCreditMemo: CREDIT
reference: '111'
status: POSTED
amount: 12.22
transactionType: DEPOSIT
- depositTransaction:
accountId: CD69feLdRMb8EskxYG2KepL4XLiSnOFRyyT
accountCategory: DEPOSIT_ACCOUNT
transactionId: '1376720570'
postedTimestamp: '2022-07-26T00:00:00.000Z'
description: TRANSFER TO MONEYACCOUNT ************1111 03-01-22 DEPOSIT TRANSFER
debitCreditMemo: DEBIT
reference: '111'
status: POSTED
amount: 2.11
transactionType: TRANSFER
Line Of Credit Paginated Full Response (CRL):
value:
paginatedArray:
page:
totalElements: 2
transactions:
- locTransaction:
accountId: PsBgRpTAT66ogdvy0wAa3qFZNpiDigawtQS
accountCategory: LOC_ACCOUNT
referenceTransactionId: '124080800081598'
transactionTimestamp: '2022-03-21T00:00:00.000Z'
description: ADVANCE TO CHECKING-0003333333333 03-21-22
debitCreditMemo: DEBIT
status: PENDING
amount: 1.00
- locTransaction:
accountId: PsBgRpTAT66ogdvy0wAa3qFZNpiDigawtQS
accountCategory: LOC_ACCOUNT
transactionId: '0101010101'
postedTimestamp: '2022-01-12T00:00:00.000Z'
description: INTEREST CHARGED
debitCreditMemo: DEBIT
status: POSTED
amount: 8.82
transactionType: INTEREST
Visa Paginated Full Response:
value:
paginatedArray:
page:
totalElements: 2
transactions:
- locTransaction:
accountId: 300ucQsGTV9Tlm2Sl3yy2hF4x60OmrFCerw
accountCategory: LOC_ACCOUNT
referenceTransactionId: '124080800081598'
transactionTimestamp: '2022-03-21T00:00:00.000Z'
description: PAYMENT - THANK YOU
debitCreditMemo: CREDIT
status: PENDING
amount: 1.00
- locTransaction:
accountId: 300ucQsGTV9Tlm2Sl3yy2hF4x60OmrFCerw
accountCategory: LOC_ACCOUNT
transactionId: '6657205677'
postedTimestamp: '2022-02-23T00:00:00.000Z'
description: '000888888888 AUTOPAY'
debitCreditMemo: CREDIT
status: POSTED
amount: 98.00
reward:
accrued: 472
adjusted: 0
type: "POINTS"
Mastercard Paginated Full Response:
value:
paginatedArray:
page:
totalElements: 3
transactions:
- locTransaction:
accountId: Y4qEwEk62xYOrpKIEssEk6ztpCOQdhfXtle
accountCategory: LOC_ACCOUNT
referenceTransactionId: '124080800081598'
transactionTimestamp: '2022-03-21T00:00:00.000Z'
description: OVERDRAFT TRF TRUIST
debitCreditMemo: CREDIT
status: PENDING
amount: 1.00
- locTransaction:
accountId: Y4qEwEk62xYOrpKIEssEk6ztpCOQdhfXtle
accountCategory: LOC_ACCOUNT
transactionId: '6657205677'
postedTimestamp: '2022-03-05T00:00:00.000Z'
description: '000888888888 AUTOPAY'
debitCreditMemo: CREDIT
status: POSTED
amount: 122.00
reward:
accrued: 472
adjusted: 0
type: "POINTS"
- locTransaction:
accountId: Y4qEwEk62xYOrpKIEssEk6ztpCOQdhfXtle
accountCategory: LOC_ACCOUNT
transactionId: '6657205677'
postedTimestamp: '2022-02-05T00:00:00.000Z'
description: '000888888888 AUTOPAY'
debitCreditMemo: CREDIT
status: POSTED
amount: 123.00
reward:
accrued: 472
adjusted: 0
type: "POINTS"
Mortgage Paginated Full Response MLA/MTG:
value:
paginatedArray:
page:
totalElements: 1
transactions:
- loanTransaction:
accountId: 35igCYFycMrL0l470ny9wuE5mMoa2LXOoas
accountCategory: LOAN_ACCOUNT
transactionId: '6657205677'
postedTimestamp: '2022-03-10T00:00:00.000Z'
description: Principal Payment
status: POSTED
amount: 3.67
transactionType: PRINCIPAL
paymentDetails:
principalAmount: 3.67
interestAmount: 0.00
escrowAmount: 0.00
Shaw Credit Line Paginated Full Response CLA/CLN:
value:
paginatedArray:
page:
totalElements: 1
transactions:
- locTransaction:
accountId: apPAcDP0EJZpFYM9cAJCe2k0DENEX4rjGOO
accountCategory: LOC_ACCOUNT
transactionId: '6657205677'
postedTimestamp: '2022-03-11T00:00:00.000Z'
debitCreditMemo: CREDIT
status: POSTED
amount: 2.00
transactionType: PAYMENT
paymentDetails:
principalAmount: 2.00
Shaw Loan Paginated Full Response CLA:
value:
paginatedArray:
page:
totalElements: 1
transactions:
- loanTransaction:
accountId: YEseynEIcdFdAkyDWllqMJ3Yu7tGUPmARot
accountCategory: LOAN_ACCOUNT
transactionId: '6657205677'
postedTimestamp: '2022-03-11T00:00:00.000Z'
status: POSTED
transactionType: PAYMENT
paymentDetails:
principalAmount: 500.00
Investment Paginated Full Response:
value:
paginatedArray:
page:
totalElements: 2
transactions:
- investmentTransaction:
accountId: AX6063932
accountCategory: INVESTMENT_ACCOUNT
referenceTransactionId: V01B2025-07-28000000000000016922042866
postedTimestamp: '2025-06-24'
transactionTimestamp: '0001-01-01T00:00:00'
description: DIVIDEND RECEIVED
amount: 3.28
transactionType: DIVIDEND
shares: 0.05
securityId: '922042866'
securityIdType: CUSIP
symbol: VPL
commission: 0
unitPrice: 66.39
units: 0.05
unitType: SHARES
settlementTimestamp: '2025-06-24'
- investmentTransaction:
accountId: AX6063932
accountCategory: INVESTMENT_ACCOUNT
referenceTransactionId: V01B2025-07-28000000000000016922042866
postedTimestamp: '2025-06-24'
transactionTimestamp: '0001-01-01T00:00:00'
description: DIVIDEND RECEIVED
amount: 8.85
transactionType: DIVIDEND
shares: 0
securityId: '922042866'
securityIdType: CUSIP
symbol: VEU
commission: 0
unitPrice: 0
units: 0
unitType: SHARES
settlementTimestamp: '2025-06-24'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'422':
$ref: '#/components/responses/422'
'429':
$ref: '#/components/responses/429'
'500':
$ref: '#/components/responses/500'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
security:
- OAuth: [TRANSACTIONS]
components:
securitySchemes:
OAuth:
type: oauth2
description:
The production authorization URL will be provided after the onboarding
process is completed.
flows:
authorizationCode:
authorizationUrl: https://api-sandbox.truist.com/retail/auth/oauth/v3/authorize
tokenUrl: https://api-sandbox.truist.com/retail/auth/oauth/v3/token
scopes:
TRANSACTIONS: Scope required to access account transactions
parameters:
############################################################
#
# Core request parameters
#
############################################################
AccountIdPath:
name: accountId
in: path
description: Account Identifier
required: true
schema:
type: string
example: 'uYrD4LD7P9948lzy3UCPHLWljGqcRWx06Tr'
OffSetQuery:
name: offset
in: query
description: offset Identifier
schema:
type: string
example: 'MjAyNS0wNC0wMXwyMDI1LTA0LTMwfFl8MTIzNDV8'
StartTimeQuery:
name: startTime
in: query
description: Required. Start date for use in retrieval of elements (ISO 8601 date as "yyyy-mm-dd")
schema:
$ref: '#/components/schemas/DateString'
example: '2022-03-01'
EndTimeQuery:
name: endTime
in: query
description: End date for use in retrieval of elements (ISO 8601 date as "yyyy-mm-dd").
Defaults to today's date
schema:
$ref: '#/components/schemas/DateString'
example: '2022-03-31'
############################################################
#
# Shared request parameters (usable by core and all extensions)
#
############################################################
FdxApiActorTypeHeader:
name: FDX-API-Actor-Type
in: header
description: Identifies whether the customer is present (USER) or it is a BATCH operation
schema:
$ref: '#/components/schemas/ActorType'
example: BATCH
FapiInteractionIdHeader:
name: x-fapi-interaction-id
in: header
description: Unique identifier for this interaction
schema:
$ref: '#/components/schemas/FapiInteractionId'
required: true
example: c770aef3-6784-41f7-8e0e-ff5f97bddb3a
headers:
############################################################
#
# Standard response headers
#
############################################################
x-fapi-interaction-id:
description: Unique identifier for this interaction
schema:
$ref: '#/components/schemas/FapiInteractionId'
required: true
example: c770aef3-6784-41f7-8e0e-ff5f97bddb3a
schemas:
############################################################
#
# Core data entities
#
############################################################
FapiInteractionId:
title: FAPI Interaction ID
description: >-
Universally unique identifier for this interaction,
used across all FDX API requests and responses
type: string
format: uuid
minLength: 36
maxLength: 36
example: c770aef3-6784-41f7-8e0e-ff5f97bddb3a
PaginatedArray:
title: Paginated Array
description: Base class for results that may be paginated
type: object
x-fdx-csdf-technical: true
properties:
page:
$ref: '#/components/schemas/PageMetadata'
description: Offset IDs for navigating result sets
x-fdx-csdf-technical: true
links:
$ref: '#/components/schemas/PageMetadataLinks'
description: Resource URLs for navigating result sets
x-fdx-csdf-technical: true
PageMetadata:
title: Page Metadata
description: Offset IDs for paginated result sets
type: object
x-fdx-csdf-technical: true
properties:
nextOffset:
type: string
example: "2"
description: Opaque identifier. Does not need to be numeric or have any specific pattern.
x-fdx-csdf-technical: true
totalElements:
type: integer
example: 3
description: Total number of elements, only available from Truist on final pagination query
x-fdx-csdf-technical: true
partialElements:
type: integer
example: 1103
description: The elements returned so far, adding these to prior pagination responses
PageMetadataLinks:
title: Page Metadata Links
description: Resource URLs for retrieving next or previous datasets
type: object
x-fdx-csdf-technical: true
properties:
next:
$ref: '#/components/schemas/HateoasLink'
description: Resource URL for retrieving next dataset
x-fdx-csdf-technical: true
HateoasLink:
title: HATEOAS Link
description: REST application constraint (Hypermedia As The Engine Of Application State)
required: [href]
type: object
x-fdx-csdf-technical: true
properties:
href:
type: string
format: uri-reference
description: URL to invoke the action on the resource
example: "https://api.fi.com/fdx/v4/accounts/12345"
x-fdx-csdf-technical: true
action:
$ref: '#/components/schemas/HttpAction'
description: HTTP Method to use for the request
x-fdx-csdf-technical: true
HttpAction:
title: HTTP Action Type
description: HTTP Methods to use for requests
type: string
x-fdx-csdf-technical: true
enum:
- GET
DepositTransaction:
title: Deposit Transaction entity
description: A transaction on a deposit account type
type: object
x-fdx-csdf-account-categories: [REG_E]
allOf:
- $ref: '#/components/schemas/Transaction'
- type: object
properties:
transactionType:
$ref: '#/components/schemas/DepositTransactionType'
description: ATMDEPOSIT, ATMWITHDRAWAL, CHECK, DEPOSIT, INTEREST, POSCREDIT, POSDEBIT, FEE
x-fdx-csdf-account-categories: [REG_E]
payee:
$ref: '#/components/schemas/String255'
description: Payee name
x-fdx-csdf-account-categories: [REG_E]
checkNumber:
type: integer
description: Check number
x-fdx-csdf-account-categories: [REG_E]
InvestmentTransaction:
title: Investment Transaction entity
description: An investment transaction
type: object
allOf:
- $ref: '#/components/schemas/Transaction'
- type: object
properties:
transactionType:
$ref: '#/components/schemas/InvestmentTransactionType'
description: >-
PURCHASED, SOLD, PURCHASEDTOCOVER, ADJUSTMENT, PURCHASETOOPEN, PURCHASETOCLOSE,
SOLDTOOPEN, SOLDTOCLOSE, INTEREST, MARGININTEREST, REINVESTOFINCOME, RETURNOFCAPITAL,
TRANSFER, CONTRIBUTION, FEE, OPTIONEXERCISE, OPTIONEXPIRATION, DIVIDEND, DIVIDENDREINVEST,
SPLIT, CLOSURE, INCOME, EXPENSE, CLOSUREOPT, INVEXPENSE, JRNLSEC, JRNLFUND, OTHER, DIV,
SRVCHG, DEP, DEPOSIT, ATM, POS, XFER, CHECK, PAYMENT, CASH, DIRECTDEP, DIRECTDEBIT, REPEATPMT
shares:
type: number
description: >-
Required for stock, mutual funds. Number of shares (with decimals).
Negative numbers indicate securities are being removed from the account
price:
type: number
description: Unit purchase price
securityId:
type: string
description: Unique identifier of security
securityIdType:
$ref: '#/components/schemas/SecurityIdType'
description: CINS, CMC, CME, CUSIP, ISIN, ITSA, NASDAQ, SEDOL, SICC, VALOR, WKN
securityType:
$ref: '#/components/schemas/SecurityType'
description: Truist is adding ANNUITY and CD per RFC 0394 with FDX v6.5, in addition
to FDX v6.4 values BOND, DEBT, MUTUALFUND, OPTION, OTHER, STOCK, SWEEP
symbol:
type: string
description: Ticker symbol
commission:
type: number
description: Transaction commission
fees:
type: number
description: Fees applied to the trade
unitPrice:
type: number
description: >-
Price per commonly-quoted unit. Does not include
markup/markdown, unitprice. Share price for stocks, mutual
funds, and others. Percentage of par for bonds. Per share (not
contract) for options
units:
type: number
description: >-
For security-based actions other than stock splits, quantity.
Shares for stocks, mutual funds, and others. Face value for bonds.
Contracts for options
unitType:
$ref: '#/components/schemas/UnitType'
description: SHARES, CURRENCY
settlementTimestamp:
description: When the trade settled
$ref: '#/components/schemas/Timestamp'
LoanTransaction:
title: Loan Transaction entity
description: A transaction on a loan account
type: object
allOf:
- $ref: '#/components/schemas/Transaction'
- type: object
properties:
transactionType:
$ref: '#/components/schemas/LoanTransactionType'
description: FEE, INTEREST, PAYMENT, PAYOFF, PRINCIPAL
paymentDetails:
$ref: '#/components/schemas/PaymentDetails'
description: Breakdown of payment details
LocTransaction:
title: Line-Of-Credit Transaction entity
description: A line-of-credit transaction
type: object
x-fdx-csdf-account-categories: [REG_Z]
allOf:
- $ref: '#/components/schemas/Transaction'
- type: object
properties:
transactionType:
$ref: '#/components/schemas/LocTransactionType'
description: FEE, INTEREST, PAYMENT
x-fdx-csdf-account-categories: [REG_Z]
checkNumber:
type: integer
description: Check number
x-fdx-csdf-account-categories: [REG_Z]
TransactionReward:
title: Transaction Reward entity
description: Rewards earned on a transaction
type: object
x-fdx-csdf-account-categories: [ANY]
properties:
accrued:
type: number
description: Reward units accrued on this transaction
x-fdx-csdf-account-categories: [ANY]
adjusted:
type: number
description: Reward units adjusted on this transaction
x-fdx-csdf-account-categories: [ANY]
type:
$ref: '#/components/schemas/RewardType'
description: The type of the reward balance - CASHBACK, MILES, POINTS.
As added to `TransactionReward` by RFC 0379 with FDX Release v6.5 in Fall 2025
x-fdx-csdf-account-categories: [ANY]
Transaction:
title: Transaction
description: Base entity for financial transactions
type: object
x-fdx-csdf-account-categories: [ANY]
properties:
accountId:
$ref: '#/components/schemas/Identifier'
description: Corresponds to AccountId in Account
x-fdx-csdf-account-categories: [ANY]
accountCategory:
$ref: '#/components/schemas/AccountCategory'
description: The category of account
x-fdx-csdf-account-categories: [ANY]
transactionId:
$ref: '#/components/schemas/Identifier'
description: Long term persistent identity of the transaction (unique to account)
x-fdx-csdf-account-categories: [ANY]
referenceTransactionId:
$ref: '#/components/schemas/Identifier'
description: >-
For reverse postings, the identity of the transaction being
reversed. For the correction transaction, the identity of the
reversing post. For credit card posting transactions, the identity
of the authorization transaction
x-fdx-csdf-account-categories: [ANY]
cardNumberDisplay:
type: string
description: >-
The payment card number (e.g. debit, credit or digital), suitably masked,
used to originate the transaction. May differ from primary account number as a
secondary or employee card or a one-time use number. This is an optional field
and won't be returned for certain types of transactions such as cash or check deposits
x-fdx-csdf-account-categories: [ANY]
postedTimestamp:
$ref: '#/components/schemas/Timestamp'
description: >-
The date and time that the transaction was posted to the account. If
not provided then Transacti
# --- truncated at 32 KB (50 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/bbandt-corp/refs/heads/main/openapi/bbandt-corp-retail-accounts-transaction-openapi.yml