Transactions
Up to two years of transaction data across account types, including amounts, dates, and descriptions.
Historical and current transactions, transaction types, amounts, dates and descriptions. May be included with all account categories except annuityAccount.
Results for transactions are returned in JSON in FDX format.
Endpoint: /transactions
API documentation: https://docs.akoya.com/v2/reference/get-transactions
Example response
{
"transactions": [
{
"depositTransaction": {
"accountId": "5242702",
"transactionId": "0203300000020",
"postedTimestamp": "2020-11-25T00:00:00Z",
"transactionTimestamp": "2020-09-10T00:00:00Z",
"description": "Manual banking 11/25",
"status": "POSTED",
"amount": -51.74,
"transactionType": "TRANSFER"
}
},
{
"depositTransaction": {
"accountId": "5242702",
"transactionId": "0203300000010",
"postedTimestamp": "2020-11-25T00:00:00Z",
"transactionTimestamp": "2020-09-11T00:00:00Z",
"description": "Manual banking",
"status": "POSTED",
"amount": 51.74,
"transactionType": "POSCREDIT"
}
},
{
"depositTransaction": {
"accountId": "5242702",
"transactionId": "0203180000010",
"postedTimestamp": "2020-11-13T00:00:00Z",
"transactionTimestamp": "2020-11-13T00:00:00Z",
"description": "MOBILE PMT 3B3RTMQZBN3TOXG WEB ID: 8369744980",
"status": "POSTED",
"amount": -200,
"transactionType": "POSDEBIT"
}
}
]
}
Supported data elements
Note
Transaction responses vary by account category.
All account categories
may include:
| Name | Type | Description |
|---|---|---|
| accountId | string | Corresponds to accountId in Account Info, Balances, and Investments responses. |
| amount | number | The amount of money in the account currency. If balanceType is ASSET:1. If debitCreditMemo = DEBIT, sign is "+" or not present2. If CREDIT, sign is "-"If balanceType is LIABILITY:1. If debitCreditMemo = DEBIT, sign is "-"2. If CREDIT, sign is "+" or not present |
| category | string | Transaction category, preferably MCC or SIC. |
| debitCreditMemo | string | The posting type of a transaction |
| description | string | The description of the transaction |
| imageIds | [string] | Array of image identifiers (unique to transaction) used to retrieve images of check or transaction receipt. |
| fiAttributes | [fiAttribute] | Array of FI-specific attributes |
| foreignAmount | number | The amount of money in the foreign currency |
| foreignCurrency | string | The ISO 4217 code of the foreign currency |
| lineItem | [lineItem] | Breakdown of the transaction details |
| links | [hateoasLink] | Links (unique to this Transaction) used to retrieve images of checks or transaction receipts, or invoke other APIs |
| memo | string | Secondary transaction description |
| postedTimestamp | string(date-time) | The date and time that the transaction was posted to the account. If not provided then TransactionTimestamp can be used as PostedTimeStamp. |
| reference | string | A tracking reference identifier |
| referenceTransactionId | string | 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. |
| status | string | AUTHORIZATION, MEMO, PENDING, or POSTED |
| subCategory | string | Transaction category detail |
| transactionId | string | Long term persistent identity of the transaction (unique to account). Transaction IDs should: 1. be the same for pending and posted 2. be different for reversed transactions 3. referenceTransactionId should be present for reversed transactions' |
| transactionTimestamp | string(date-time) | The date and time that the transaction was added to the server backend systems. |
Deposit transactions
may also include:
| Name | Type | Description |
|---|---|---|
| payee | string | Payee name |
| checkNumber | integer | Check Number |
| transactionType | string | depositTransaction type: CHECK, WITHDRAWAL, TRANSFER, POSDEBIT, ATMWITHDRAWAL, BILLPAYMENT, FEE, DEPOSIT, ADJUSTMENT, INTEREST, DIVIDEND, DIRECTDEPOSIT, ATMDEPOSIT, POSCREDIT |
Insurance transactions
may also include:
| Name | Type | Description |
|---|---|---|
| transactionType | string | insuranceTransaction type: PAYMENT, FEE, ADJUSTMENT, INTEREST |
Investment transactions
may also include:
| Name | Type | Description |
|---|---|---|
| accruedInterest | number | Accrued Interest. |
| commission | number | Transaction commission. |
| confirmationNumber | string | Confirmation number of the transaction. |
| faceValue | number | Cash value for bonds. |
| fees | number | Fees applied to the trade. |
| fractionalCash | number | Cash for fractional units (used for stock splits). |
| gain | number | For sales. |
| incomeType | string | Type of investment income. CGLONG (capital gains-long term), CGSHORT (capital gains-short term), MISC. |
| inv401kSource | string | Source of money. |
| load | number | Load on the transaction. |
| loanId | string | For 401k accounts only. This indicates the transaction was due to a loan or a loan repayment. |
| loanInterest | number | How much loan pre-payment is interest. |
| loanPrincipal | number | How much loan pre-payment is principal. |
| markup | number | Portion of unit price that is attributed to the dealer markup. |
| newUnits | number | Number of shares after split. |
| oldUnits | number | Number of shares before split. |
| payrollDate | string | The date for the 401k transaction was obtained in payroll. |
| penalty | number | Indicates amount withheld due to a penalty. |
| positionType | string | |
| price | number | Unit purchase price. |
| priorYearContrib | boolean | Indicates this buy was made using prior years contribution. TRUE or FALSE. |
| runningBalance | number | Running balance of the position. |
| securityId | string | Unique identifier of security. |
| securityIdType | string | Security identifier type. |
| securityType | string | |
| shares | number | Required for stock, mutual funds. Number of shares (with decimals). Negative numbers indicate securities are being removed from the account. |
| splitRatioDenominator | number | Split ratio denominator. |
| splitRatioNumerator | number | Split ratio numerator. |
| stateWithholding | number | State tax withholding. |
| subAccountFund | string | From which account money came in. |
| subAccountSec | string | Sub-account security type. |
| symbol | string | Ticker symbol. |
| taxes | number | Taxes on the trade. |
| taxExempt | boolean | Tax-exempt transaction TRUE or FALSE. |
| transactionReason | string | Reason for this transaction; CALL (the debt was called), SELL (the debt was sold), MATURITY (the debt reached maturity) |
| transactionType | string | investmentTransaction type: 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 |
| transferAction | string | Transfer direction. |
| unitPrice | number | 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 | number | For security-based actions other than stock splits, quantity. Shares for stocks, mutual funds, and others. Face value for bonds. Contracts for options. |
| unitType | string | |
| withholding | number | Federal tax withholding. |
Line of credit transactions
may also include:
| Name | Type | Description |
|---|---|---|
| checkNumber | integer | Check number |
| paymentDetails | [paymentDetails] | Payment details for some transactions |
| paymentDetails.escrowAmount | number | The amount of payment applied to escrow |
| paymentDetails.feesAmount | number | The amount of payment applied to fees |
| paymentDetails.insuranceAmount | number | The amount of payment applied to life/health/accident insurance on the loan |
| paymentDetails.interestAmount | number | The amount of payment applied to interest |
| paymentDetails.pmiAmount | number | The amount of payment applied to PMI |
| paymentDetails.principalAmount | number | The amount of payment applied to principal |
| transactionType | string | locTransaction type: CHECK, WITHDRAWAL, TRANSFER, POSDEBIT, ATMWITHDRAWAL, BILLPAYMENT, FEE, DEPOSIT, ADJUSTMENT, INTEREST, DIVIDEND, DIRECTDEPOSIT, ATMDEPOSIT, POSCREDIT |
Loan transactions
may also include:
| Name | Type | Description |
|---|---|---|
| paymentDetails | [paymentDetails] | Payment details for some transactions |
| paymentDetails.escrowAmount | number | The amount of payment applied to escrow |
| paymentDetails.feesAmount | number | The amount of payment applied to fees |
| paymentDetails.insuranceAmount | number | The amount of payment applied to life/health/accident insurance on the loan |
| paymentDetails.interestAmount | number | The amount of payment applied to interest |
| paymentDetails.pmiAmount | number | The amount of payment applied to PMI |
| paymentDetails.principalAmount | number | The amount of payment applied to principal |
| transactionType | string | loanTransaction type: ADJUSTMENT, FEE, INTEREST, PAYMENT |
Updated over 1 year ago