v1

latestOpenAPI 3.0.32026-07-13347237.5 KB

Connect

Get Accounts Summary

To access general account details such as the cardholder's name (when available), account balance, account category and EFT eligibility, use the /GetAccountsSummary endpoint.

post/v3/{customerId}/BankingServices/GetAccountsSummary

Path parameters

customerIdstring required

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

Headers

x-api-keystring

Security feature that grants access to this endpoint.

Request body

RequestIdstring required

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

WithBalanceboolean

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

WithAccountIdentityboolean

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

Example request

{
  "RequestId": "3fa391bc-bc52-4424-82c5-8662600df9b2",
  "WithBalance": true,
  "WithAccountIdentity": true
}

Response

Success

HttpStatusCodeinteger

HTTP status code of the response.

Tagstring

User tag (if provided).

InstitutionNamestring

Name of the financial institution.

InstitutionIdinteger

Unique identifier of the financial institution.

Institutionstring

Name of the financial institution.

RequestIdstring