get https://api.talkdeskapp.com/fsi/contacts//accounts
Associated with a contact
Scope
fsi-accounts:read
Body Response - Schema
200 (the accounts list)
| Parameter | Type | Description | Required |
|---|---|---|---|
| _embedded | object | "_embedded" subdivides into: 1 - "accounts" (array[object]) - list of accounts. Required. 1.1 - "id" (string) - identification for an account. Required. 1.2 - "description" (string) - description of the account. Required. 1.3 - "account_number" (string) - account number associated. 1.4 - "currency_code" (string) - currency used in this account using ISO 4217 standard. > = 3 characters > <= 3 characters. Required. > 1.5 - "iban" (string) - IBAN number associated to this account. > <= 34 characters. > 1.6 - "financial_institution_name" (string) - financial institution name. > 1.7 - "swift_code" (string) - SWIFT code associated to this account. > = 8 characters > <= 11 characters > 1.8 - "account_name" (string) - name provided by the account owner. > 1.9 - "account_type" (string) - account type. Allowed values: > "UNDEFINED", "CHECKING", "SAVINGS", > "CREDIT_CARD", "CREDIT". Required. > 1.10 - "parties" (array[object]) - list of parties. A party is a person or company associated with the account. >= 0 items. > 1.10.1 - "contact_id" (string) - identifier for a contact. Required. > 1.10.2 - "role" (string) - type of role associated with a party member. Allowed values: "HOLDER", > "AUTHORIZED_PARTY", > "OTHER", "UNKNOWN", > "JOINT", "PRIMARY", > "SECONDARY". Required. > 1.10.3 - "custom_role" (string) - account's customized party by bank client. > 1.10.4 - "transfer_permission" (boolean) - indicates if the party has permission to transfer funds. > 1.11 - "update_at" (string) > 1.12 - "open_date" (string) - account's created date. > 1.13 - "close_date" (string) - account's closed date. > 1.14 - "balance" (string) - account's booked balance. > 1.15 - "available_balance" (string) - account's available balance. > 1.16 - "status" (string) - account type. Allowed values: "ACTIVE", > "INACTIVE", "OPEN", > "CLOSED", "CHARGE_OFF", "FROZEN". Required. > 1.17 - "custom_type" (string) - account's customized type by bank client. > 1.18 - "custom_status" (string) - account's customized status by bank client. > 1.19 - "_links" (string) - self link item for HAL. > 1.19.1 - "self" (object) - link of the current page. Required. > 1.19.1.1 - "href" (string) - address of the resource. | yes |
| total | integer | Total number of accounts in the collection. >= 0 Default: 0 | no |
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) |
API Availability
The FSI Integrations API has been in General Availability since January 2023.
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.