Skip to main content
POST
/
v3
/
{customerId}
/
BankingServices
/
GetAccountsSummary
Get Accounts Summary
curl --request POST \
  --url https://{instance}-api.private.fin.ag/v3/{customerId}/BankingServices/GetAccountsSummary \
  --header 'Content-Type: application/json' \
  --data '
{
  "RequestId": "3fa391bc-bc52-4424-82c5-8662600df9b2"
}
'
{
  "HttpStatusCode": 200,
  "Accounts": [
    {
      "EftEligibleRatio": 0,
      "ETransferEligibleRatio": 0,
      "Title": "Primary Chequing Account",
      "AccountNumber": "1234567",
      "LastFourDigits": null,
      "Balance": {
        "Available": 1234.45,
        "Current": 4321.45,
        "Limit": null
      },
      "Category": "Operations",
      "Type": "Chequing",
      "Currency": "CAD",
      "Holder": {
        "Name": "John Doe",
        "Address": {
          "CivicAddress": "20 Park Avenue",
          "City": "Toronto",
          "Province": "ON",
          "PostalCode": "X1X X2X",
          "POBox": null,
          "Country": "CA"
        },
        "Email": "[email protected]",
        "PhoneNumber": "+1 123-456-7890"
      },
      "AccountType": "Personal",
      "Id": "xxxx-xxxx-xxxxxxx-xxxxxx"
    }
  ],
  "Links": [
    {
      "rel": "AccountsDetail",
      "href": "/GetAccountsDetail",
      "example": null
    },
    {
      "rel": "Statements",
      "href": "/GetStatements",
      "example": null
    }
  ],
  "Tag": "userId=xxxxxxxxxxxx",
  "InstitutionName": "BMO",
  "Login": {
    "Username": "1234567890",
    "IsScheduledRefresh": false,
    "LastRefresh": "2024-10-10T12:00:00.000000",
    "Type": "Business",
    "Id": "xxxx-xxxx-xxxxxx-xxxxxx"
  },
  "InstitutionId": 1,
  "Institution": "BMO",
  "RequestId": "xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx"
}
To access general account details such as the cardholder’s name (when available), account balance, account category and EFT eligibility, use the /GetAccountsSummary endpoint. Before calling this endpoint, you must first invoke the /Authorize endpoint to obtain a valid RequestId. This RequestId is required to successfully request /GetAccountsSummary.

​
Accounts Summary

The /GetAccountsSummary endpoint provides the following details for all linked accounts:
PERSONAL INFORMATIONACCOUNT INFORMATION
Holder name (when available)EftEligibleRatio
ETransferEligibleRatio
Account title
Account balance
Account category
Currency
Account type

​
EFT Eligibility

The EftEligibleRatio field is a decimal value between 0 and 1, representing a percentage. It reflects how often we’ve successfully retrieved the necessary information to perform an Electronic Funds Transfer (EFT) from a given account. The higher the number, the higher the possibility is of getting the required information from the /GetAccountDetails endpoint. Use this field to guide users in selecting an account for EFT transactions. It helps filter out accounts that may not support EFT functionality reliably.

Headers

​
x-api-key
string

Security feature that grants access to this endpoint.

Path Parameters

​
customerId
string
default:43387ca6-0391-4c82-857d-70d95f087ecb
required

Unique GUID provided by Flinks that grants you access to the environment specified in the instance field.

Body

application/json
​
RequestId
string
required

Unique identifier provided after a successful request to the /Authorize endpoint.

​
WithBalance
boolean
default:true

Specifies if you want to include account balances in the account summary.

​
WithAccountIdentity
boolean
default:true

Specifies if you want to include the account numbers in the account summary.

Response

Success

​
HttpStatusCode
integer

HTTP status code of the response.

​
Accounts
object[]
​
Links
object[]

List of available data endpoints.

​
Tag
string

User tag (if provided).

​
InstitutionName
string

Name of the financial institution.

​
Login
object

Login information.

​
InstitutionId
integer

Unique identifier of the financial institution.

​
Institution
string

Name of the financial institution.

​
RequestId
string