Connections

Get financial connection

GET

/finance/connections/{connectionId}

curl --request GET \
  --url https://api.synci.io/api/v1/finance/connections/{connectionId} \
  --header 'Authorization: Bearer <token>'

{
  "data": {
    "access_valid_for_days": "<string>",
    "accounts_last_synced_at": "<string>",
    "activated_at": "<string>",
    "consent_expires_at": "<string>",
    "created_at": "<string>",
    "enabled": "<string>",
    "financial_accounts": [
      {
        "account_category": "<string>",
        "account_number_masked": "<string>",
        "account_usage": "<string>",
        "balance": {
          "available": "<string>",
          "cleared": "<string>"
        },
        "balances_last_synced_at": "<string>",
        "bban": "<string>",
        "bic": "<string>",
        "cash_account_type": "<string>",
        "cash_balance": {
          "amount": "<string>",
          "currency": "<string>"
        },
        "config": {
          "enrichment": {
            "country": "<string>",
            "enabled": "<string>",
            "provider": "<string>"
          },
          "fields_for_duplicate_filtering": [
            "<string>"
          ],
          "fuzzy_counterparty_matching": "<string>",
          "fuzzy_counterparty_min_chars": "<string>",
          "map_fields": {
            "date": "<string>",
            "description": "<string>",
            "payee": "<string>"
          },
          "pending_settlement_matching": "<string>",
          "pending_settlement_max_days": "<string>",
          "sync_auto": "<string>",
          "sync_balances": "<string>",
          "sync_frequency_in_minutes": "<string>",
          "sync_pending_transactions": "<string>",
          "sync_start_date": "2025-01-01"
        },
        "created_at": "<string>",
        "currency": "<string>",
        "custom_name": "<string>",
        "details": "<string>",
        "details_last_synced_at": "<string>",
        "display_name": "<string>",
        "enabled": "<string>",
        "financial_connection": {},
        "financial_connection_id": "<string>",
        "health": {
          "failure_count": "<string>",
          "integrator_message": "<string>",
          "last_attempt_at": "<string>",
          "status": "<string>",
          "transient_failure_count": "<string>",
          "transient_message": "<string>"
        },
        "iban": "<string>",
        "id": "<string>",
        "institution_id": "<string>",
        "integrator": "<string>",
        "integrator_id": "<string>",
        "linked_accounts": "<string>",
        "meta": "<string>",
        "msisdn": "<string>",
        "name": "<string>",
        "owner_address": "<string>",
        "owner_name": "<string>",
        "product_name": "<string>",
        "raw_type": "<string>",
        "rules": [

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

connectionIdintegerrequired

The financial connection ID

Response

FinancialConnectionResource

dataobjectrequired

Show child attributes

Still need help? Ask the team