Bank Account Verification
...
Consent-based
US

Get customer transactions using customer ID

introduction this api helps to get the transaction details of the account holder using the customer id 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 customer id of the account holder should be used as the input 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" 1607450357, "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" 1607450357, "fromdate" "1607450357", "todate" "1607450357" }' request body parameters parameter required description customerid yes customer 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 description result found the total number of results matching search criteria result displaying the number of results returned result moreavailable if this is true then, you can retrieve the next page of results by increasing the value of the start parameter in your next request result fromdate the date from which the transaction detail is available result todate the date upto which the transaction detail is available result sort value of the sort request parameter that generated this response result transactions the array of transactions transactions id this shows the transaction id transactions amount the amount that is transacted is shown here transactions accountid the id of the account from which the transaction is done transactions customerid the customer id linked with the customer transactions status this shows the status of the transaction active, pending or shadow transactions description 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 transactions memo the institution must provide either a description, a memo, or both we recommended concatenating the two fields into a single value transactions type the type of transaction that is done by the customer is shown here transactions transactiondate this shows the date on which the transaction was done transactions posteddate represents the timestamp of the transaction when it was posted or cleared by the institution transactions createddate represents the timestamp of the transaction when it was added to our platform transactions firsteffectivedate represents the first timestamp of the transaction recorded in the effectivedate field transactions effectivedate represents the timestamp of the transaction when it became effective on an account by an institution transactions checknum the check number of the transaction transactions escrowamount the portion of the transaction allocated to escrow transactions feeamount the portion of the overall transaction amount applied to fees transactions suspenseamount temporarily hold funds if you overpay or underpay your monthly payment transactions interestamount the portion of the transaction allocated to interest transactions principalamount the portion of the transaction allocated to principal transactions unitquantity the number of units/individual shares in the transaction transactions unitprice 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 city where the transaction took place categorization state state where the transaction was done categorization postalcode postal code of the place of transaction categorization country coiuntry where the transaction took place categorization bestrepresentation combines the description and memo data together, removing duplicated information and numbers and special characters transactions runningbalanceamount this shows the running balance amount in the account of the customer transactions subaccountsecuritytype the type of sub account the funds came from transactions comissionamount transaction commission transactions ticker ticker symbol for the investment related to the transaction transactions investmenttransactiontype keywords in the description and memo fields were used to translate investment transactions into these types transactions taxesamount taxes applicable to the investment trade transactions currencysymbol this shows the symbol of the currency in which the trasnction took place transactions incometype taxes applicable to the investment trade transactions splitdenominator denominator of the stock split for the transaction transactions splitnumerator numerator of the stock split for the transaction transactions sharespercontract shares per contract of the underlying stock option transactions accountfund the sub account where the funds came from transactions securityid security id of the transaction transactions securityidtype the security type this field is related to the securityid field 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!