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

curl --location --request GET 'https://sandbox-products.ddp.akoya.com/transactions/v2/{providerId}/{accountId}' --header 'Content-Type: application/x-www-form-urlencoded' --header 'Authorization: Bearer {id_token}

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:

NameTypeDescription
accountIdstringCorresponds to accountId in Account Info, Balances, and Investments responses.
amountnumberThe amount of money in the account currency.

If balanceType is ASSET:

1. If debitCreditMemo = DEBIT, sign is "+" or not present
2. If CREDIT, sign is "-"

If balanceType is LIABILITY:

1. If debitCreditMemo = DEBIT, sign is "-"
2. If CREDIT, sign is "+" or not present
categorystringTransaction category, preferably MCC or SIC.
debitCreditMemostringAkoya will ensure that this is correctly populated with one of DEBIT or CREDIT and matches the sign of the status field.
descriptionstringThe 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
foreignAmountnumberThe amount of money in the foreign currency
foreignCurrencystringThe 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
memostringSecondary transaction description
postedTimestampstring(date-time)The date and time that the transaction was posted to the account. If not provided then TransactionTimestamp can be used as PostedTimeStamp.
referencestringA tracking reference identifier
referenceTransactionIdstringAkoya ensures that this field is populated for all transactions which are reversals, otherwise it is null. Either way it is always present.

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.
statusstringAUTHORIZATION, MEMO, PENDING, or POSTED
subCategorystringTransaction category detail
transactionIdstringLong 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'
transactionTimestampstring(date-time)The date and time that the transaction was added to the server backend systems.

Akoya ensures that this field is populated for all transactions to which it applies, otherwise it is null. Either way it is always present.

Deposit transactions

may also include:

NameTypeDescription
payeestringPayee name
checkNumberintegerCheck Number
transactionTypestringdepositTransaction type: CHECK, WITHDRAWAL, TRANSFER, POSDEBIT, ATMWITHDRAWAL, BILLPAYMENT, FEE, DEPOSIT, ADJUSTMENT, INTEREST, DIVIDEND, DIRECTDEPOSIT, ATMDEPOSIT, POSCREDIT

Insurance transactions

may also include:

NameTypeDescription
transactionTypestringinsuranceTransaction type: PAYMENT, FEE, ADJUSTMENT, INTEREST

Investment transactions

may also include:

NameTypeDescription
accruedInterestnumberAccrued Interest.
commissionnumberTransaction commission.
confirmationNumberstringConfirmation number of the transaction.
faceValuenumberCash value for bonds.
feesnumberFees applied to the trade.
fractionalCashnumberCash for fractional units (used for stock splits).
gainnumberFor sales.
incomeTypestringType of investment income. CGLONG (capital gains-long term), CGSHORT (capital gains-short term), MISC.
inv401kSourcestringSource of money.
loadnumberLoad on the transaction.
loanIdstringFor 401k accounts only. This indicates the transaction was due to a loan or a loan repayment.
loanInterestnumberHow much loan pre-payment is interest.
loanPrincipalnumberHow much loan pre-payment is principal.
markupnumberPortion of unit price that is attributed to the dealer markup.
newUnitsnumberNumber of shares after split.
oldUnitsnumberNumber of shares before split.
payrollDatestringThe date for the 401k transaction was obtained in payroll.
penaltynumberIndicates amount withheld due to a penalty.
positionTypestring
pricenumberUnit purchase price.
priorYearContribbooleanIndicates this buy was made using prior years contribution. TRUE or FALSE.
runningBalancenumberRunning balance of the position.
securityIdstringUnique identifier of security.
securityIdTypestringSecurity identifier type.
securityTypestring
sharesnumberRequired for stock, mutual funds. Number of shares (with decimals). Negative numbers indicate securities are being removed from the account.
splitRatioDenominatornumberSplit ratio denominator.
splitRatioNumeratornumberSplit ratio numerator.
stateWithholdingnumberState tax withholding.
subAccountFundstringFrom which account money came in.
subAccountSecstringSub-account security type.
symbolstringTicker symbol.
taxesnumberTaxes on the trade.
taxExemptbooleanTax-exempt transaction TRUE or FALSE.
transactionReasonstringReason for this transaction; CALL (the debt was called), SELL (the debt was sold), MATURITY (the debt reached maturity)
transactionTypestringinvestmentTransaction 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
transferActionstringTransfer direction.
unitPricenumberPrice 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.
unitsnumberFor security-based actions other than stock splits, quantity. Shares for stocks, mutual funds, and others. Face value for bonds. Contracts for options.
unitTypestring
withholdingnumberFederal tax withholding.

Line of credit transactions

may also include:

NameTypeDescription
checkNumberintegerCheck number
paymentDetails[paymentDetails]Payment details for some transactions
paymentDetails.escrowAmountnumberThe amount of payment applied to escrow
paymentDetails.feesAmountnumberThe amount of payment applied to fees
paymentDetails.insuranceAmountnumberThe amount of payment applied to life/health/accident insurance on the loan
paymentDetails.interestAmountnumberThe amount of payment applied to interest
paymentDetails.pmiAmountnumberThe amount of payment applied to PMI
paymentDetails.principalAmountnumberThe amount of payment applied to principal
transactionTypestringlocTransaction type: CHECK, WITHDRAWAL, TRANSFER, POSDEBIT, ATMWITHDRAWAL, BILLPAYMENT, FEE, DEPOSIT, ADJUSTMENT, INTEREST, DIVIDEND, DIRECTDEPOSIT, ATMDEPOSIT, POSCREDIT

Loan transactions

may also include:

NameTypeDescription
paymentDetails[paymentDetails]Payment details for some transactions
paymentDetails.escrowAmountnumberThe amount of payment applied to escrow
paymentDetails.feesAmountnumberThe amount of payment applied to fees
paymentDetails.insuranceAmountnumberThe amount of payment applied to life/health/accident insurance on the loan
paymentDetails.interestAmountnumberThe amount of payment applied to interest
paymentDetails.pmiAmountnumberThe amount of payment applied to PMI
paymentDetails.principalAmountnumberThe amount of payment applied to principal
transactionTypestringloanTransaction type: ADJUSTMENT, FEE, INTEREST, PAYMENT