Skip to main content
GET
/
v3
/
{customerId}
/
BankingServices
/
GetAccountsDetailAsync
/
{requestId}
Get Accounts Detail Async
curl --request GET \
  --url https://{instance}-api.private.fin.ag/v3/{customerId}/BankingServices/GetAccountsDetailAsync/{requestId} \
  --header 'Accept: <accept>' \
  --header 'Content-Type: <content-type>'
{
  "HttpStatusCode": 200,
  "Accounts": [
    {
      "Transactions": [
        {
          "Date": "2025-01-31",
          "Code": null,
          "Description": "PAYROLL - Stripe Paycheck",
          "Debit": 1000.4,
          "Credit": 1500.25,
          "Balance": 5105.6,
          "Id": "94584aed-7c98-42a4-9836-9f8557db63f5"
        },
        {
          "Date": "2025-01-30",
          "Code": null,
          "Description": "Credit Card Payment",
          "Debit": 150,
          "Credit": 100,
          "Balance": 3605,
          "Id": "c2fb949a-86aa-470f-9a76-deb10d7c2b57"
        }
      ],
      "TransitNumber": "12347",
      "InstitutionNumber": "777",
      "OverdraftLimit": 100.5,
      "Title": "Chequing Account",
      "AccountNumber": "7641238",
      "LastFourDigits": null,
      "Balance": {
        "Available": 5405.5,
        "Current": 5105.5,
        "Limit": 5105.5
      },
      "Category": "Operations",
      "Type": "Chequing",
      "Currency": "CAD",
      "Holder": {
        "Name": "Testing",
        "Address": {
          "CivicAddress": "25 york street",
          "City": "TOR",
          "Province": "ON",
          "PostalCode": "M5J 2V5",
          "POBox": null,
          "Country": "CA"
        },
        "Email": "test_user1@nomail.com",
        "PhoneNumber": "9051234567"
      },
      "AccountType": null,
      "Id": "27a9ffa0-c6b9-4cc6-9eaa-aa9efa07a889"
    }
  ],
  "InstitutionName": "FlinksCapital",
  "Login": {
    "Username": "chat_gpt",
    "IsScheduledRefresh": false,
    "LastRefresh": "2025-01-31T17:40:54.569261",
    "Type": "Personal",
    "Id": "5602459c-f6d0-4ca0-6750-08dccdcadcc0"
  },
  "InstitutionId": 14,
  "Institution": "FlinksCapital",
  "RequestId": "22178382-31ee-485c-a750-c20929b6a344"
}
Use the /GetAccountsDetailAsync endpoint to get pending requests from /GetAccountsDetail. You must first call the /GetAccountsDetail endpoint to obtain a valid requestId.

​
Checking if the request is still pending

When you receive a 202 HTTPS response from /GetAccountsDetail stating that your request is still pending, you must call the /GetAccountsDetailAsync endpoint every 10 seconds to check if the data is finished processing for a maximum of 30 minutes. Your request will likely take a few seconds to process, but setting a 30-minute timeout avoids infinite loops of this request.

​
Receiving the data after it’s processed

You’ll get a 200 HTTPS response when the data is finished processing. The API delivers the data to you as a JSON payload in a standard format, and your servers can start to handle it in the way that your use case is set up to.

Headers

​
x-api-key
string

Security feature that grants access to this endpoint, but it must be enabled by Flinks. Please contact your Flinks representative to activate it.

​
Content-Type
enum<string>
default:application/json
required

Content type of the request.

Available options:
application/json
Example:

"application/json"

​
Accept
string
default:application/json
required

Acceptable response media type.

Example:

"application/json"

Path Parameters

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

Key that grants access to the environment specified in the instance field. By default, the value is set to the toolbox environment key.

​
requestId
string
required

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

Response

Result

​
HttpStatusCode
integer

HTTP status code of the response.

​
Accounts
object[]

Array containing detailed information about each linked account.

​
InstitutionName
string

Name of the financial institution.

​
Login
object

Login information.

​
InstitutionId
integer

Numeric identifier for the financial institution.

​
Institution
string

Institution name or code.

​
RequestId
string

Unique request identifier.