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 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 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 n umber 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 { "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 { "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 help\@signzy com 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!