Accounts

Update financial account

PUT

/finance/accounts/{accountId}

curl --request PUT \
  --url https://api.synci.io/api/v1/finance/accounts/{accountId} \
  --header 'Authorization: Bearer <token>'

{
  "data": {
    "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": {
      "access_valid_for_days": "<string>",
      "accounts_last_synced_at": "<string>",
      "activated_at": "<string>",
      "consent_expires_at": "<string>",
      "created_at": "<string>",
      "enabled": "<string>",
      "financial_accounts": [
        {}
      ],
      "financial_accounts_count": "<string>",
      "health": {
        "failure_count": "<string>",
        "integrator_message": "<string>",
        "last_attempt_at": "<string>",
        "status": "<string>",
        "transient_failure_count": "<string>",
        "transient_message": "<string>"
      },
      "id": "<string>",
      "institution": {
        "bic": "<string>",
        "category": "<string>",
        "country": "<string>",
        "external_id": "<string>",
        "id": "<string>",
        "integrator": "<string>",
        "logo": "<string>",
        "max_access_valid_for_days": "<string>",
        "max_historical_days": "<string>",
        "name": "<string>",
        "region": "<string>",

Authorizations

Authorizationstringheaderrequired

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

Path Parameters

accountIdintegerrequired

The financial account ID

Body

bbanstring

Basic Bank Account Number (BBAN). Must be provided if IBAN is not provided.

Maximum string length: 255

bicstring | null

Institution Identifier Code (BIC/SWIFT code).

Maximum string length: 255

configobject | null

The financial account's configuration

Show child attributes

currencystring | null

ISO 4217 currency code.

Required string length: 3 - 3

Pattern: ^[A-Z]{3}$

custom_namestring | null

Custom name for the account, as defined by the end user.

Maximum string length: 255

detailsstring | null

Specifications that might be provided by the financial institution - characteristics of the account - characteristics of the relevant card.

Maximum string length: 255

display_namestring | null

Name of the account as defined by the end user within online channels.

Maximum string length: 255

ibanstring

International Bank Account Number (IBAN). Must be provided if BBAN is not provided.

Maximum string length: 255

institution_idstring | null

The financial account ID provided by the institution/bank.

Maximum string length: 255

integrator_idstring | null

The financial account ID provided by the integrator.

Maximum string length: 255

msisdnstring | null

An alias to a payment account via a registered mobile phone number.

Maximum string length: 255

namestring

Name of the account, as assigned by the financial institution.

Maximum string length: 255

owner_namestring | null

Name of the legal account owner. If there is more than one owner, then e.g. two names might be noted here. For a corporate account, the corporate name is used for this attribute.

Maximum string length: 255

product_namestring | null

Product Name of the Institution for this account, proprietary definition.

Maximum string length: 255

Response

dataobjectrequired

Show child attributes

messagestringrequired

Still need help? Ask the team