Transfer Links

Get transfer link

GET

/transfer-links/{transferLinkId}

Get transfer link

curl --request GET \
  --url https://api.synci.io/api/v1/transfer-links/{transferLinkId} \
  --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>",
        "cleared": "<string>"

Authorizations

Authorizationstringheaderrequired

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

Path Parameters

transferLinkIdintegerrequired

The transfer link ID

Response

TransferLinkResource

dataobjectrequired

Show child attributes

Still need help? Ask the team