https://sandbox-products.ddp.akoya.com/transactions/{version}/{providerId}/{accountId}
The transactions API allows you to retrieve transaction history of consumer-permissioned accounts.
For more information on how to paginate transaction results, please see: Pagination
Use the mode query param to receive FDX-aligned, standardized data values (Beta). For example:
https://sandbox-products.ddp.akoya.com/transactions/v2/mikomo?mode=standard
mode is available in both sandbox and production.
mode is supported by a subset of providers. Log into the Data Recipient Hub and click here to view a list of all providers supporting the mode parameter.
version*
stringdefault: v2Akoya major version number. Do not use minor version numbers. For instance, use v2 and not v2.2
providerId*
stringdefault: mikomoId of provider
accountId*
stringdefault: :accountIdAccount Identifier
startTime
stringISO 8601 date format in UTC time zone. If blank, the default value (current date - 15 calendar days) is used. If a value is specified, endTime is required.
endTime
stringISO 8601 date format in UTC time zone. If blank, the default value (current date) is used. If a value is specified, startTime is required.
offset
stringdefault: 0The number of items to skip before the first in the response. The default is 0.
limit
integerdefault: 50The maximum number of items to be returned in the response. The default is 50.
mode
stringBETA. Default is raw. Use standard for FDX-aligned, standardized data values.
x-akoya-interaction-type
stringOptional but recommended header to include with each data request. Allowed values are `user` or `batch`. `user` indicates a request is prompted by an end-user action. `batch` indicates the request is part of a batch process.
200
OK
Response Body
links
object
next
object
href
string
prev
object
href
string
transactions
array of objects
An array of transactions with entity types dependent on the account type (deposit, investment, loan, or line of credit)
Any of:
depositTransaction
accountId
string
Corresponds to AccountId in Account
amount
number
The 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
category
string
Transaction category, preferably MCC or SIC.
debitCreditMemo
string
Akoya will ensure that this is correctly populated with one of DEBIT or CREDIT and matches the sign of the status field.
description
string
The description of the transaction
imageIds
array of strings
Array of image identifiers (unique to transaction) used to retrieve images of check or transaction receipt.
string
fiAttributes
array of objects
Array of FI-specific attributes
object
name
string
Name of attribute
value
string
Value of attribute
foreignAmount
number
The amount of money in the foreign currency
foreignCurrency
string
The ISO 4217 code of the foreign currency
lineItem
array of objects
Breakdown of the transaction details
object
amount
number
The amount of money attributable to this line item
checkNumber
number
Check number
description
string
The description of the line item
imageIds
array of strings
Array of image identifiers (unique to transaction) used to retrieve images of check or transaction receipt
string
links
array of objects
Links (unique to this Transaction) used to retrieve images of checks or transaction receipts, or invoke other APIs
object
href
string
URL to invoke the action on the resource
action
string
HTTP Method to use for the request
types
array of strings
Content-types that can be used in the Accept header.
string
memo
string
Secondary item description
reference
string
A reference number
links
array of objects
Links (unique to this Transaction) used to retrieve images of checks or transaction receipts, or invoke other APIs
object
href
string
URL to invoke the action on the resource
action
string
HTTP Method to use for the request
types
array of strings
Content-types that can be used in the Accept header.
string
memo
string
Secondary transaction description
postedTimestamp
string
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
Akoya 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.
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
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.
payee
string
Payee name
checkNumber
integer
Check Number
transactionType
string
DepositTransaction Type
loanTransaction
accountId
string
Corresponds to AccountId in Account
amount
number
The 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
category
string
Transaction category, preferably MCC or SIC.
debitCreditMemo
string
Akoya will ensure that this is correctly populated with one of DEBIT or CREDIT and matches the sign of the status field.
description
string
The description of the transaction
imageIds
array of strings
Array of image identifiers (unique to transaction) used to retrieve images of check or transaction receipt.
string
fiAttributes
array of objects
Array of FI-specific attributes
object
name
string
Name of attribute
value
string
Value of attribute
foreignAmount
number
The amount of money in the foreign currency
foreignCurrency
string
The ISO 4217 code of the foreign currency
lineItem
array of objects
Breakdown of the transaction details
object
amount
number
The amount of money attributable to this line item
checkNumber
number
Check number
description
string
The description of the line item
imageIds
array of strings
Array of image identifiers (unique to transaction) used to retrieve images of check or transaction receipt
string
links
array of objects
Links (unique to this Transaction) used to retrieve images of checks or transaction receipts, or invoke other APIs
object
href
string
URL to invoke the action on the resource
action
string
HTTP Method to use for the request
types
array of strings
Content-types that can be used in the Accept header.
string
memo
string
Secondary item description
reference
string
A reference number
links
array of objects
Links (unique to this Transaction) used to retrieve images of checks or transaction receipts, or invoke other APIs
object
href
string
URL to invoke the action on the resource
action
string
HTTP Method to use for the request
types
array of strings
Content-types that can be used in the Accept header.
string
memo
string
Secondary transaction description
postedTimestamp
string
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
Akoya 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.
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
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.
paymentDetails
object
escrowAmount
number
The amount of payment applied to escrow
feesAmount
number
The amount of payment applied to fees
insuranceAmount
number
The amount of payment applied to life/health/accident insurance on the loan
interestAmount
number
The amount of payment applied to interest
pmiAmount
number
The amount of payment applied to PMI
principalAmount
number
The amount of payment applied to principal
transactionType
string
LoanTransaction Type
locTransaction
accountId
string
Corresponds to AccountId in Account
amount
number
The 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
category
string
Transaction category, preferably MCC or SIC.
debitCreditMemo
string
Akoya will ensure that this is correctly populated with one of DEBIT or CREDIT and matches the sign of the status field.
description
string
The description of the transaction
imageIds
array of strings
Array of image identifiers (unique to transaction) used to retrieve images of check or transaction receipt.
string
fiAttributes
array of objects
Array of FI-specific attributes
object
name
string
Name of attribute
value
string
Value of attribute
foreignAmount
number
The amount of money in the foreign currency
foreignCurrency
string
The ISO 4217 code of the foreign currency
lineItem
array of objects
Breakdown of the transaction details
object
amount
number
The amount of money attributable to this line item
checkNumber
number
Check number
description
string
The description of the line item
imageIds
array of strings
Array of image identifiers (unique to transaction) used to retrieve images of check or transaction receipt
string
links
array of objects
Links (unique to this Transaction) used to retrieve images of checks or transaction receipts, or invoke other APIs
object
href
string
URL to invoke the action on the resource
action
string
HTTP Method to use for the request
types
array of strings
Content-types that can be used in the Accept header.
string
memo
string
Secondary item description
reference
string
A reference number
links
array of objects
Links (unique to this Transaction) used to retrieve images of checks or transaction receipts, or invoke other APIs
object
href
string
URL to invoke the action on the resource
action
string
HTTP Method to use for the request
types
array of strings
Content-types that can be used in the Accept header.
string
memo
string
Secondary transaction description
postedTimestamp
string
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
Akoya 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.
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
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.
checkNumber
integer
Check number
paymentDetails
object
escrowAmount
number
The amount of payment applied to escrow
feesAmount
number
The amount of payment applied to fees
insuranceAmount
number
The amount of payment applied to life/health/accident insurance on the loan
interestAmount
number
The amount of payment applied to interest
pmiAmount
number
The amount of payment applied to PMI
principalAmount
number
The amount of payment applied to principal
transactionType
string
LocTransaction Type
investmentTransaction
accountId
string
Corresponds to AccountId in Account
amount
number
The 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
category
string
Transaction category, preferably MCC or SIC.
debitCreditMemo
string
Akoya will ensure that this is correctly populated with one of DEBIT or CREDIT and matches the sign of the status field.
description
string
The description of the transaction
imageIds
array of strings
Array of image identifiers (unique to transaction) used to retrieve images of check or transaction receipt.
string
fiAttributes
array of objects
Array of FI-specific attributes
object
name
string
Name of attribute
value
string
Value of attribute
foreignAmount
number
The amount of money in the foreign currency
foreignCurrency
string
The ISO 4217 code of the foreign currency
lineItem
array of objects
Breakdown of the transaction details
object
amount
number
The amount of money attributable to this line item
checkNumber
number
Check number
description
string
The description of the line item
imageIds
array of strings
Array of image identifiers (unique to transaction) used to retrieve images of check or transaction receipt
string
links
array of objects
Links (unique to this Transaction) used to retrieve images of checks or transaction receipts, or invoke other APIs
object
href
string
URL to invoke the action on the resource
action
string
HTTP Method to use for the request
types
array of strings
Content-types that can be used in the Accept header.
string
memo
string
Secondary item description
reference
string
A reference number
links
array of objects
Links (unique to this Transaction) used to retrieve images of checks or transaction receipts, or invoke other APIs
object
href
string
URL to invoke the action on the resource
action
string
HTTP Method to use for the request
types
array of strings
Content-types that can be used in the Accept header.
string
memo
string
Secondary transaction description
postedTimestamp
string
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
Akoya 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.
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
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.
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
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.
insuranceTransaction
accountId
string
Corresponds to AccountId in Account
amount
number
The 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
category
string
Transaction category, preferably MCC or SIC.
debitCreditMemo
string
Akoya will ensure that this is correctly populated with one of DEBIT or CREDIT and matches the sign of the status field.
description
string
The description of the transaction
imageIds
array of strings
Array of image identifiers (unique to transaction) used to retrieve images of check or transaction receipt.
string
fiAttributes
array of objects
Array of FI-specific attributes
object
name
string
Name of attribute
value
string
Value of attribute
foreignAmount
number
The amount of money in the foreign currency
foreignCurrency
string
The ISO 4217 code of the foreign currency
lineItem
array of objects
Breakdown of the transaction details
object
amount
number
The amount of money attributable to this line item
checkNumber
number
Check number
description
string
The description of the line item
imageIds
array of strings
Array of image identifiers (unique to transaction) used to retrieve images of check or transaction receipt
string
links
array of objects
Links (unique to this Transaction) used to retrieve images of checks or transaction receipts, or invoke other APIs
object
href
string
URL to invoke the action on the resource
action
string
HTTP Method to use for the request
types
array of strings
Content-types that can be used in the Accept header.
string
memo
string
Secondary item description
reference
string
A reference number
links
array of objects
Links (unique to this Transaction) used to retrieve images of checks or transaction receipts, or invoke other APIs
object
href
string
URL to invoke the action on the resource
action
string
HTTP Method to use for the request
types
array of strings
Content-types that can be used in the Accept header.
string
memo
string
Secondary transaction description
postedTimestamp
string
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
Akoya 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.
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
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.
transactionType
string
InsuranceTransaction Type
Headers
x-akoya-interaction-idstring
Akoya supplied interaction id used for logging and error tracking
400
Bad Request
Response Body
object
code
integer
Long term persistent identifier which can be used to trace error condition back to log information
message
string
End user displayable information which might help the customer diagnose an error
401
602 - Customer not authorized
Response Body
code
integer
message
string
404
701 - Tax Lots not found. The `holdingId` may be wrong.
Response Body
code
integer
message
string
406
1203 - Content Type not Supported
Response Body
object
code
integer
Long term persistent identifier which can be used to trace error condition back to log information
message
string
End user displayable information which might help the customer diagnose an error
429
1207 - Too many requests
Response Body
object
code
integer
Long term persistent identifier which can be used to trace error condition back to log information
message
string
End user displayable information which might help the customer diagnose an error
500
500 - Internal server error
Response Body
object
code
integer
Long term persistent identifier which can be used to trace error condition back to log information
message
string
End user displayable information which might help the customer diagnose an error
501
1106 - Version not supported or not implemented
Response Body
object
code
integer
Long term persistent identifier which can be used to trace error condition back to log information
message
string
End user displayable information which might help the customer diagnose an error
503
503 - System is down for maintenance
Response Body
object
code
integer
Long term persistent identifier which can be used to trace error condition back to log information
message
string
End user displayable information which might help the customer diagnose an error
const options = {
"method": "GET",
"headers": {
"x-akoya-interaction-type": "batch"
}
}};
fetch('https://sandbox-products.ddp.akoya.com/transactions/v2/mikomo/:accountId?mode=raw&startTime=2020-03-30T04%3A00%3A00Z&endTime=2021-03-30T04%3A00%3A00Z&offset=0&limit=50', options)
.then(response => response.json())
.catch(err => console.error(err));