Get customer transactions using account ID

Introduction
This API helps to get the transaction details of the account holder using the customerID & accountID that is linked with the customer.
Get all transactions available for this customer account within the given date range.
Standard consumer aggregation provides up to 180 days of transactions prior to the date each account was added to the Finicity system. 
There is no limit for the size of the window between fromDate and toDate, however, the maximum number of transactions returned on one page is 1000.
Supported regions: US
API Details
Need to pass following information:
Customer ID
Account ID
fromDate
toDate
Sample Curl
Production
Pre-Production
Curl
curl --location --request POST 'https://api.signzy.app/api/v3/bank-connect/transactions?fromDate=1670220883&toDate=1672899283&limit=100&sort=asc' \
--header 'Authorization: <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "customerId": "6019521730",
    "accountId": "6032346608"
    "fromdate": "1607450357"
    "todate": "1607450357"
}'

curl --location --request POST 'https://api.signzy.app/api/v3/bank-connect/transactions?fromDate=1670220883&toDate=1672899283&limit=100&sort=asc' \
--header 'Authorization: <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "customerId": "6019521730",
    "accountId": "6032346608"
    "fromdate": "1607450357"
    "todate": "1607450357"
}'
﻿
Curl
curl --location --request POST 'https://api-preproduction.signzy.app/api/v3/bank-connect/transactions?fromDate=1670220883&toDate=1672899283&limit=100&sort=asc' \
--header 'Authorization: <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "customerId": "6019521730",
    "accountId": "6032346608"
    "fromdate": "1607450357"
    "todate": "1607450357"
}'

curl --location --request POST 'https://api-preproduction.signzy.app/api/v3/bank-connect/transactions?fromDate=1670220883&toDate=1672899283&limit=100&sort=asc' \
--header 'Authorization: <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "customerId": "6019521730",
    "accountId": "6032346608"
    "fromdate": "1607450357"
    "todate": "1607450357"
}'
﻿
Request Body Parameters
Parameter
Required
Description
customerId
Yes
Customer ID of the customer
accountId
Yes
Account ID of the customer
fromDate
Yes
Timestamp of starting date object
toDate
Yes
Timestamp of ending date object
limit
Optional
Number of transactions in response
start
Optional
Starting index for this page (basically skip field in other paginated applications)
sort
Optional
Sort order: desc or asc. Default is desc for descending order (newest transactions are on page 1); also allows asc for ascending order (oldest transactions are on page )
Sample Response
JSON
{
  "found": number
  "displaying": number
  "moreAvailable": boolean,
  "fromDate": number
  "toDate": number
  "sort": string
  "transactions": [
    {
      "id": number
      "amount": number
      "accountId": number
      "customerId": number
      "status": string
      "description": string
      "memo": string
      "type": string
      "transactionDate": number
      "postedDate": number
      "createdDate": number
      "firstEffectiveDate": number
      "effectiveDate": number
      "checkNum": number
      "escrowAmount": number
      "feeAmount": number
      "suspenseAmount": number
      "interestAmount": number
      "principalAmount": number
      "unitQuantity": number
      "unitPrice": number
      "categorization": {
        "normalizedPayeeName": string
        "category": string
        "city": string
        "state": string
        "postalCode": string
        "country": string
        "bestRepresentation": string
      },
      "runningBalanceAmount": number
      "subaccountSecurityType": string
      "commissionAmount": number
      "ticker": string
      "investmentTransactionType": string
      "taxesAmount": number
      "currencySymbol": string
      "incomeType": string
      "splitDenominator": number
      "splitNumerator": number
      "sharesPerContract": number
      "subAccountFund": string
      "securityId": string
      "securityIdType": string
    }
  ]
}
{
  "found": number
  "displaying": number
  "moreAvailable": boolean,
  "fromDate": number
  "toDate": number
  "sort": string
  "transactions": [
    {
      "id": number
      "amount": number
      "accountId": number
      "customerId": number
      "status": string
      "description": string
      "memo": string
      "type": string
      "transactionDate": number
      "postedDate": number
      "createdDate": number
      "firstEffectiveDate": number
      "effectiveDate": number
      "checkNum": number
      "escrowAmount": number
      "feeAmount": number
      "suspenseAmount": number
      "interestAmount": number
      "principalAmount": number
      "unitQuantity": number
      "unitPrice": number
      "categorization": {
        "normalizedPayeeName": string
        "category": string
        "city": string
        "state": string
        "postalCode": string
        "country": string
        "bestRepresentation": string
      },
      "runningBalanceAmount": number
      "subaccountSecurityType": string
      "commissionAmount": number
      "ticker": string
      "investmentTransactionType": string
      "taxesAmount": number
      "currencySymbol": string
      "incomeType": string
      "splitDenominator": number
      "splitNumerator": number
      "sharesPerContract": number
      "subAccountFund": string
      "securityId": string
      "securityIdType": string
    }
  ]
}
﻿
Response Body Parameters
Parameter
Data Type
Description
result.found
integer
The total number of results matching search criteria
result.displaying
integer
The number of results returned.
result.moreAvailable
boolean
If the value of moreAvailable is "true", you can retrieve the next page of results by increasing the value of the start parameter in your next request:"...&start=6&limit=5"
example: true
result.fromDate
integer
Value of the fromDate request parameter that generated this response
result.toDate
integer
Value of the toDate request parameter that generated this response
result.sort
string
Value of the sort request parameter that generated this response.
example: "desc"
result.transactions
array[Transaction]
The array of transactions.
transactions.id
integer
This shows the transaction ID
transactions.amount
number
The total amount of the transaction. Transactions for deposits are positive values, withdrawals and debits are negative values.
example: -828.9
transactions.accountId
integer
An account ID represented as a number
transactions.customerId
integer
A customer ID represented as a number. 
transactions.status
string
One of "active", "pending", or "shadow" 
example: "active"
transactions.description
string
The description value is from the financial institution (FI), often known as the payee. The value "No description provided by institution" is returned when the FI doesn't provide one
example: "Buy Stock"
transactions.memo
string
The institution must provide either a description, a memo, or both. We recommended concatenating the two fields into a single value.
example: "UWM HOLDINGS CORPORATION - CLASS A COMMON STOCK"
transactions.type
string
If provided by the institution, the following values may be returned in the field of a record:
"atm"
"cash"
"check"
"credit"
"debit"
"deposit"
"directDebit"
"directDeposit"
"dividend"
"fee"
"interest"
"other"
"payment"
"pointOfSale"
"repeatPayment"
"serviceCharge"
"transfer"
example: "atm"
transactions.transactionDate
integer
This shows the date on which the transaction was done.
transactions.postedDate
integer
Represents the timestamp of the transaction when it was posted or cleared by the institution.
transactions.createdDate
integer
Represents the timestamp of the transaction when it was added to our platform.
transactions.firstEffectiveDate
integer
Represents the first timestamp of the transaction recorded in the effectiveDate field.
transactions.effectiveDate
integer
Represents the timestamp of the transaction when it became effective on an account by an institution.
transactions.checkNum
integer
The check number of the transaction.
transactions.escrowAmount
number
The portion of the transaction allocated to escrow.
transactions.feeAmount
number
The portion of the overall transaction amount applied to fees.
transactions.suspenseAmount
number
Temporarily hold funds if you overpay or underpay your monthly payment.
transactions.interestAmount
number
The portion of the transaction allocated to interest.
transactions.principalAmount
number
The portion of the transaction allocated to principal.
transactions.unitQuantity
integer
The number of units/individual shares in the transaction.
transactions.unitPrice
number
Share price for the investment unit: stocks, mutual funds, ETFs
categorization.normalizedPayeeName
﻿
A normalized payee, derived from the transaction's description and memo fields.
categorization.category
﻿
The different categories for transactions, like, atm fee, bonus, bills and utility etc.
categorization.city
string
City where the transaction took place.
categorization.state
string
State where the transaction was done.
categorization.postalCode
string
Postal code of the place of transaction.
categorization.country
string
Coiuntry where the transaction took place.
categorization.bestRepresentation
string
Combines the description and memo data together, removing duplicated information and numbers and special characters
transactions.runningBalanceAmount
number
This shows the running balance amount in the account of the customer.
transactions.subaccountSecurityType
string
The type of sub account the funds came from.
transactions.comissionAmount
integer
Transaction commission.
transactions.ticker
string
Ticker symbol for the investment related to the transaction.
transactions.investmentTransactionType
string
Keywords in the description and memo fields were used to translate investment transactions into these types. 
Possible values:
"cancel"
"purchaseToClose"
"purchaseToCover"
"contribution"
"optionExercise"
"optionExpiration"
"fee"
"soldToClose"
"soldToOpen"
"split"
"transfer"
"returnOfCapital"
"income"
"purchased"
"sold"
"dividendreInvest"
"tax"
"dividend"
"reinvestOfIncome"
"interest"
"deposit"
"otherInfo"
example: "transfer"
transactions.taxesAmount
integer
Taxes applicable to the investment trade
transactions.currencySymbol
string
This shows the symbol of the currency in which the trasnction took place.
transactions.incomeType
string
Taxes applicable to the investment trade
transactions.splitDenominator
number
Denominator of the stock split for the transaction.
transactions.splitNumerator
number
Numerator of the stock split for the transaction.
transactions.sharesPerContract
number
Shares per contract of the underlying stock option.
transactions.AccountFund
string
The sub account where the funds came from.
transactions.securityId
string
Security ID of the transaction.
transactions.securityIdType
string
The security type. This field is related to the securityId field.
﻿
Possible values:
"CUSIP"
"ISIN"
"SEDOL"
"SICC"
"VALOR"
"WKN"
example: "CUSIP"
Sample Error
JSON
{
    "error": {
        "name": "error",
        "message": "..message..",
        "status": 400,
        "reason": "BadRequest",
        "type": "OK",
        "statusCode": 200
    }
}
{
    "error": {
        "name": "error",
        "message": "..message..",
        "status": 400,
        "reason": "BadRequest",
        "type": "OK",
        "statusCode": 200
    }
}
﻿
Error Response Parameters
Parameter
Description
error
This parameter contains the error.
error.name
the name of the error
error.message
the error message
error.status
status of the api
error.reason
Reason for error
error.type
Type of the error
error.statusCode
Request Status code from Signzy
Getting help
Please feel free to contact us if you have any questions, require clarification, or have ideas for how to make the documents or any of our services better.
You can reach out to us at [email protected]. We strive to provide prompt and reliable assistance, ensuring your queries are addressed effectively.
We value your feedback and are committed to making your experience smooth and enjoyable. Our team is dedicated to assisting you with any needs you may have. Thank you for choosing our services. We look forward to helping you!
﻿

Parameter	Required	Description
customerId	Yes	Customer ID of the customer
accountId	Yes	Account ID of the customer
fromDate	Yes	Timestamp of starting date object
toDate	Yes	Timestamp of ending date object
limit	Optional	Number of transactions in response
start	Optional	Starting index for this page (basically skip field in other paginated applications)
sort	Optional	Sort order: desc or asc. Default is desc for descending order (newest transactions are on page 1); also allows asc for ascending order (oldest transactions are on page )

Parameter	Data Type	Description
result.found	integer	The total number of results matching search criteria
result.displaying	integer	The number of results returned.
result.moreAvailable	boolean	If the value of moreAvailable is "true", you can retrieve the next page of results by increasing the value of the start parameter in your next request:"...&start=6&limit=5" example: true
result.fromDate	integer	Value of the fromDate request parameter that generated this response
result.toDate	integer	Value of the toDate request parameter that generated this response
result.sort	string	Value of the sort request parameter that generated this response. example: "desc"
result.transactions	array[Transaction]	The array of transactions.
transactions.id	integer	This shows the transaction ID
transactions.amount	number	The total amount of the transaction. Transactions for deposits are positive values, withdrawals and debits are negative values. example: -828.9
transactions.accountId	integer	An account ID represented as a number
transactions.customerId	integer	A customer ID represented as a number.
transactions.status	string	One of "active", "pending", or "shadow" example: "active"
transactions.description	string	The description value is from the financial institution (FI), often known as the payee. The value "No description provided by institution" is returned when the FI doesn't provide one example: "Buy Stock"
transactions.memo	string	The institution must provide either a description, a memo, or both. We recommended concatenating the two fields into a single value. example: "UWM HOLDINGS CORPORATION - CLASS A COMMON STOCK"
transactions.type	string	If provided by the institution, the following values may be returned in the field of a record: "atm" "cash" "check" "credit" "debit" "deposit" "directDebit" "directDeposit" "dividend" "fee" "interest" "other" "payment" "pointOfSale" "repeatPayment" "serviceCharge" "transfer" example: "atm"
transactions.transactionDate	integer	This shows the date on which the transaction was done.
transactions.postedDate	integer	Represents the timestamp of the transaction when it was posted or cleared by the institution.
transactions.createdDate	integer	Represents the timestamp of the transaction when it was added to our platform.
transactions.firstEffectiveDate	integer	Represents the first timestamp of the transaction recorded in the effectiveDate field.
transactions.effectiveDate	integer	Represents the timestamp of the transaction when it became effective on an account by an institution.
transactions.checkNum	integer	The check number of the transaction.
transactions.escrowAmount	number	The portion of the transaction allocated to escrow.
transactions.feeAmount	number	The portion of the overall transaction amount applied to fees.
transactions.suspenseAmount	number	Temporarily hold funds if you overpay or underpay your monthly payment.
transactions.interestAmount	number	The portion of the transaction allocated to interest.
transactions.principalAmount	number	The portion of the transaction allocated to principal.
transactions.unitQuantity	integer	The number of units/individual shares in the transaction.
transactions.unitPrice	number	Share price for the investment unit: stocks, mutual funds, ETFs
categorization.normalizedPayeeName		A normalized payee, derived from the transaction's description and memo fields.
categorization.category		The different categories for transactions, like, atm fee, bonus, bills and utility etc.
categorization.city	string	City where the transaction took place.
categorization.state	string	State where the transaction was done.
categorization.postalCode	string	Postal code of the place of transaction.
categorization.country	string	Coiuntry where the transaction took place.
categorization.bestRepresentation	string	Combines the description and memo data together, removing duplicated information and numbers and special characters
transactions.runningBalanceAmount	number	This shows the running balance amount in the account of the customer.
transactions.subaccountSecurityType	string	The type of sub account the funds came from.
transactions.comissionAmount	integer	Transaction commission.
transactions.ticker	string	Ticker symbol for the investment related to the transaction.
transactions.investmentTransactionType	string	Keywords in the description and memo fields were used to translate investment transactions into these types. Possible values: "cancel" "purchaseToClose" "purchaseToCover" "contribution" "optionExercise" "optionExpiration" "fee" "soldToClose" "soldToOpen" "split" "transfer" "returnOfCapital" "income" "purchased" "sold" "dividendreInvest" "tax" "dividend" "reinvestOfIncome" "interest" "deposit" "otherInfo" example: "transfer"
transactions.taxesAmount	integer	Taxes applicable to the investment trade
transactions.currencySymbol	string	This shows the symbol of the currency in which the trasnction took place.
transactions.incomeType	string	Taxes applicable to the investment trade
transactions.splitDenominator	number	Denominator of the stock split for the transaction.
transactions.splitNumerator	number	Numerator of the stock split for the transaction.
transactions.sharesPerContract	number	Shares per contract of the underlying stock option.
transactions.AccountFund	string	The sub account where the funds came from.
transactions.securityId	string	Security ID of the transaction.
transactions.securityIdType	string	The security type. This field is related to the securityId field. Possible values: "CUSIP" "ISIN" "SEDOL" "SICC" "VALOR" "WKN" example: "CUSIP"

Parameter	Description
error	This parameter contains the error.
error.name	the name of the error
error.message	the error message
error.status	status of the api
error.reason	Reason for error
error.type	Type of the error
error.statusCode	Request Status code from Signzy

Did this page help you?

Delete Customer

Get customer transactions using customer ID