get
https://your-url-here.com/fsi/contacts//acc
Body response
200 OK
| Parameter | Type | Description |
|---|---|---|
| _embedded | object | accounts array[object] required List of accounts id string required Identification for an account description string required Description of the account account_number string Account number associated currency_code string required Currency used in this account using ISO 4217 standard > = 3 characters > <= 3 characters > iban > string > IBAN number associated to this account<= 34 characters financial_institution_name string Financial institution name swift_code string SWIFT code associated to this account > = 8 characters > <= 11 characters > account_name > string > Name provided by the account owner (nickname)account_type string required Account type Allowed values: DEBIT UNDEFINED SAVINGS CHECKING CERTIFICATE_OF_DEPOSIT STUDENT MORTGAGE_LOAN HOME_EQUITY_LOAN AUTO_LOAN PERSONAL_LOAN BUSINESS_LOAN STUDENT_LOAN CREDIT_CARD CREDIT BUSINESS_CREDIT_CARD STUDENT_CREDIT_CARD PERSONAL_CREDIT_CARD OTHER parties array[object] required List of parties. A party is a person or company associated with the account. > = 0 items > contact_id > string > required > Identifier for a contactrole string required Type of role associated with a party member Allowed values: HOLDER AUTHORIZED_PARTY OTHER UNKNOWN JOINT PRIMARY SECONDARY custom_role string Account's customized party by bank client transfer_permission boolean Indicates if the party has permission to transfer funds update_at string open_date string Account's created date close_date string Account's closed date balance string required Account's booked balance. For loans this field will be equal to "Current Principal Balance" available_balance string required Account's available balance status string required Account type Allowed values: ACTIVE INACTIVE OPEN CLOSED CHARGE_OFF FROZEN custom_type string Account's customized type by bank client custom_status string Account's customized status by bank client custom_fields array[object] Custom fields list. It allows the core the retrieve custom data for each FSI account. key string required custom field name value string custom field value loan_number string The loan number interest_details object interest_rate string The interest rate interest_rate_type string Interest rate type Allowed values: FIXED VARIABLE ANNUAL_PERCENTAGE PRIME DISCOUNTED SIMPLE COMPOUND last_interest_paid string Last interest paid last_interest_paid_date string Last interest paid date Example: 2021-06-16 ytd_interest_paid string Current ytd interest paid previous_year_interest_paid string Previous year interest paid previous_year_taxes_paid string One value expected with the sum of all year taxes paid last_statement_date string Last statement date Example: 2021-06-16 credit_limit string Credit limit statement_balance string Statement balance next_closing_date string Next closing date Example: 2021-06-16 periodic_frequency string Periodic Frequency purchase_apr string Purchase APR cash_advance_apr string Cash advance APR balance_transfer_apr string Balance transfer APR term string The term loan_start_date string Loan start date Example: 2021-06-16 maturity_date string Maturity date Example: 2021-06-16 loan_amount string Contracted loan amount property_address string The property address automatic_payment boolean Automatic payment automatic_payment_date string Automatic payment date Example: 2021-06-16 monthly_loan_payment_details object monthly_loan_payment string Monthly loan payment principal_payment string Principal payment (detail amount of monthly_loan_payment) interest_payment string Interest payment (detail amount of monthly_loan_payment) monthly_escrow_payment string Monthly escrow payment (detail amount of monthly_loan_payment) fee string Fee payment (detail amount of monthly_loan_payment) account_routing_number string The MICR routing number consists of 9 digits (XXXXYYYYC) where XXXX is Federal Reserve Routing Symbol, YYYY is ABA Institution Identifier, and C is the check digit. transfer_authorization string Transfer Authorization. INQUIRY means transfers and withdrawals not allowed; TRANSFERS means allowed transfers depending on transferRules; TRANSFERS_AND_WITHDRAWALS means allowed transfers depending on transferRules, and withdrawals to be made from the account. Allowed values: INQUIRY TRANSFERS TRANSFERS_AND_WITHDRAWALS transfer_rules object Transfer Rules transfer_in boolean Active when the account has permission to receive money from other accounts. transfer_out_own_accounts boolean Active when the account has permission to send money between own accounts. transfer_out_others boolean Active when the account has permission to send money to other accounts of the same bank. transfer_out_external boolean Active when the account has permission to send money to other accounts of a different bank. transfer_out_international boolean Active when the account has permission to send money to international accounts. withdrawals_by_check boolean Active then allows withdrawals from the account by check. |
| total | integer | required Total number of accounts in the collection > = 0 > Default: > 0 |
400 (bad request) 401 (unauthorized), 403 (forbidden), 404 (not found)
| Parameter | Type | Description | Required |
|---|---|---|---|
| code | string | n/a | yes |
| message | string | n/a | yes |
| description | string | n/a | no |
| fields | array[object] | "fields" subdivides into: "name" (string) "description" (string) | yes (name and description) |
Troubleshooting
If you have any questions regarding the usage of this API, or if you’re having any technical issues, please open a ticket using this form.