Transfer Links

List all transfer links

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.

GET

/transfer-links

curl --request GET \
  --url https://api.synci.io/api/v1/transfer-links \
  --header 'Authorization: Bearer <token>'

{
  "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>",

Authorizations

Authorizationstringheaderrequired

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

Query Parameters

page[size]integerquerydefault:25

The number of results that will be returned per page.

page[number]integerquery

The page number to start the pagination from.

filter[financial_account_id]stringquery

Filter transfer links by the ID of the financial account transactions are transferred from.

filter[destination_id]stringquery

Filter transfer links by the ID of the destination transactions are transferred to.

filter[active]stringquery

Filter transfer links by whether they are enabled.

filter[destination_type]stringquery

Filter transfer links by destination type, for example YNAB, LUNCH_MONEY, or GOOGLE_SHEETS.

filter[search]stringquery

Search for transfer links by commonly populated fields

sortenum<string>[]querydefault:["-id"]

includeenum<string>[]query

Response

Paginated set of TransferLinkResource

dataobject[]required

Show child attributes

linksobjectrequired

Show child attributes

metaobjectrequired

Show child attributes

Still need help? Ask the team