Transfer Links

Create a new transfer link

Transfer links are used to transfer transactions from a financial account to a destination. Once a transfer link is created, Synci will automatically transfer bank transactions to the destination according to the link's configuration. Financial accounts and destinations can have multiple transfer links.

POST

/transfer-links

curl --request POST \
  --url https://api.synci.io/api/v1/transfer-links \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "destination_type": "YNAB",
  "financial_account_id": 123
}
'

{
  "data": {
    "active": "<string>",
    "created_at": "<string>",
    "destination": {
      "balance": "<string>",
      "budget": {
        "accounts": [
          {}
        ],
        "connection": {
          "auth_url": "<string>",
          "budgets": [
            {}
          ],
          "created_at": "<string>",
          "enabled": "<string>",
          "health": {
            "failure_count": "<string>",
            "integrator_message": "<string>",
            "last_attempt_at": "<string>",
            "status": "<string>",
            "transient_failure_count": "<string>",
            "transient_message": "<string>"
          },
          "id": "<string>",
          "last_synced_at": "<string>",
          "name": "<string>",
          "sync_balances": "<string>",
          "updated_at": "<string>",
          "ynab_user_id": "<string>"
        },
        "connection_id": "<string>",
        "created_at": "<string>",
        "currency": "<string>",
        "enabled": "<string>",
        "first_month": "<string>",
        "id": "<string>",
        "last_month": "<string>",
        "last_synced_at": "<string>",
        "name": "<string>",
        "updated_at": "<string>",
        "ynab_id": "<string>"
      },
      "budget_id": "<string>",
      "cleared_balance": "<string>",
      "closed": "<string>",
      "created_at": "<string>",
      "direct_import_linked": "<string>",
      "health": {
        "failure_count": "<string>",
        "integrator_message": "<string>",
        "last_attempt_at": "<string>",
        "status": "<string>",
        "transient_failure_count": "<string>",
        "transient_message": "<string>"
      },
      "id": "<string>",
      "last_reconciled_at": "<string>",
      "name": "<string>",
      "note": "<string>",
      "on_budget": "<string>",
      "transfer_links": [
        {}
      ],
      "transfer_payee_id": "<string>",
      "type": "<string>",
      "uncleared_balance": "<string>",
      "updated_at": "<string>",
      "ynab_id": "<string>"
    },
    "destination_id": "<string>",
    "destination_type": "<string>",
    "financial_account": {
      "account_category": "<string>",
      "account_number_masked": "<string>",
      "account_usage": "<string>",
      "balance": {
        "available": "<string>",
        "cleared": "<string>"

Authorizations

Authorizationstringheaderrequired

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

Body

activeboolean | null

Whether the transfer link is active.

destination_idinteger

The ID of the destination transactions should be transferred to.<br> The type of resource the ID refers to depends on the destination type:

YNAB: the ID of a YNAB budget account.
LUNCH_MONEY: the ID of a Lunch Money account.
GOOGLE_SHEETS: the ID of a Google Sheet.

destination_typeenum<string>required

The type of destination the transfer link sends transactions to:

YNAB: a YNAB budget account.
LUNCH_MONEY: a Lunch Money account.
GOOGLE_SHEETS: a Google Sheet.

Available options: YNAB, LUNCH_MONEY, GOOGLE_SHEETS, NOTION

financial_account_idintegerrequired

The ID of the financial account transactions are being transferred from.

on_booked_changeobject

Which destination fields to update when a transaction's booked status changes. If not provided, all fields will be updated.

Show child attributes

sync_modeenum<string> | null

Which streams to push to the destination:

transactions: only individual transactions (default for bank sources)
balance: only periodic balance snapshots
transactions_and_balance: both (default for brokerage / crypto sources)


`TRANSACTIONS` <br/> Push individual transactions only.
`BALANCE` <br/> Push periodic balance snapshots only.
`TRANSACTIONS_AND_BALANCE` <br/> Push both transactions and balance snapshots.

Available options: TRANSACTIONS, BALANCE, TRANSACTIONS_AND_BALANCE

transfer_start_datestring | null

The date from which the transfer link will start transferring transactions. If not provided, all available transactions in the attached financial account will be transferred regardless of their date.

Example: 2025-01-01

Response

dataobjectrequired

Show child attributes

messagestringrequired

Still need help? Ask the team