Synci API
  1. TransferLinks
Synci API
  • BankAccounts
    • List all bank accounts
      GET
    • Get bank account
      GET
    • Update bank account
      PUT
    • Delete bank account
      DELETE
    • Reset bank account config to defaults
      DELETE
    • List all balances
      GET
    • Get balance
      GET
    • Delete balance
      DELETE
  • BankConnections
    • List all bank connections
      GET
    • Create a new bank connection
      POST
    • Get bank connection
      GET
    • Delete bank connection
      DELETE
    • Disable bank connection
      PUT
    • Reconfirm the consent of a bank connection
      PUT
  • BankTransactions
    • List all bank transactions
      GET
    • Create a new bank transaction
      POST
    • Get bank transaction
      GET
    • Update bank transaction
      PUT
    • Delete bank transaction
      DELETE
  • RuleActions
    • List all rule actions
    • Create a new rule action
    • Get rule action
    • Update rule action
    • Delete rule action
  • RuleConditions
    • List rule conditions
    • Create a new rule condition
    • Get rule condition
    • Update rule condition
    • Delete rule condition
  • RuleLogs
    • List all rule logs
    • Get rule log
    • Undo a rule action
  • Rules
    • Create a new rule
    • List all rules
    • Get rule
    • Update rule
    • Delete rule
    • Attach rule to bank account
    • Detach rule from bank account
    • Reorder rules for a bank account
    • Attach rule to transfer link
    • Detach rule from transfer link
    • Reorder rules for a transfer link
    • Attach rule to destination
    • Detach rule from destination
    • Reorder rules for a destination (e.g., YNAB budget account)
    • rules.attachToBank
    • rules.detachFromBank
  • Statistics
    • Get bank transaction statistics
    • Get key user statistics
    • Get transfer statistics
  • SupportedBanks
    • Get supported countries
    • List all supported banks
    • Get supported bank
  • TransferLinks
    • List all transfer links
      GET
    • Create a new transfer link
      POST
    • Get transfer link
      GET
    • Update transfer link
      PUT
    • Delete transfer link
      DELETE
    • Retry transfers for all transfer links
      POST
    • Retry transfers for a specific transfer link
      POST
  • TransferLogs
    • List all transfer logs
    • Get transfer log
    • Undo a transfer
    • transfer-logs.undo-bulk
  • YnabBudgets
    • List all YNAB budgets
    • Get YNAB budget
    • Delete YNAB budget
    • Update YNAB connection
    • List all YNAB budget accounts
    • Get YNAB budget account
    • Delete YNAB budget account
    • List all YNAB budget payees
    • List all YNAB budget categories
    • List all YNAB budget transactions
  • YnabConnections
    • List all YNAB connections
    • Create new YNAB connection
    • Get YNAB connection
    • Delete YNAB connection
  • Schemas
    • Schemas
      • AttachRuleToDestinationRequest
      • BalanceTypeEnum
      • BankAccount
      • BankAccountResource
      • BankBalanceResource
      • BankConfigGeneratedDateEnum
      • BankConfigGeneratedTextEnum
      • BankConfigResource
      • BankConnectionResource
      • BankIntegratorEnum
      • BankResource
      • BankTransactionResource
      • BulkUndoTransferLogsRequest
      • CreateBankConnectionRequest
      • CreateBankTransactionRequest
      • CreateRuleRequest
      • CreateTransferLinkRequest
      • CreateYnabConnectionRequest
      • DestinationTypeEnum
      • GoCardlessRequisitionStatusEnum
      • HealthResource
      • HealthStatusEnum
      • ReauthorizeBankConnectionRequest
      • ReorderDestinationRulesRequest
      • RetryTransfersAllLinksRequest
      • RetryTransfersRequest
      • RuleActionResource
      • RuleActionTypeEnum
      • RuleConditionResource
      • RuleLogResource
      • RuleOperatorEnum
      • RuleResource
      • RuleTypeEnum
      • SourceTypeEnum
      • TransactionTypeEnum
      • TransferLink
      • TransferLinkResource
      • TransferLogResource
      • TransferLogStatusEnum
      • UpdateBankAccountRequest
      • UpdateBankTransactionRequest
      • UpdateRuleRequest
      • UpdateTransferLinkRequest
      • UpdateYnabBudgetRequest
      • YnabBudgetAccountResource
      • YnabBudgetAccountTypeEnum
      • YnabBudgetCategoryResource
      • YnabBudgetPayeeResource
      • YnabBudgetResource
      • YnabBudgetTransactionResource
      • YnabConnectionResource
    • Response
      • AuthenticationException
      • ValidationException
      • AuthorizationException
      • ModelNotFoundException
  1. TransferLinks

List all transfer links

GET
/transfer-links
Transfer links are used to transfer transactions from a bank 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.
Bank accounts and destinations can have multiple transfer links.

Request

Authorization
Bearer Token
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
or
Query Params

Responses

๐ŸŸข200OK
application/json
Paginated set of TransferLinkResource
Body

๐ŸŸ 401Unauthorized
๐ŸŸ 403Forbidden
Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request GET 'https://api.synci.io/api/v1/transfer-links?sort&include&page[size]&page[number]&filter[bank_account_id]&filter[destination_id]&filter[active]&filter[destination_type]&filter[search]' \
--header 'Authorization: Bearer <token>'
Response Response Example
200 - Example 1
{
    "data": [
        {
            "id": 0,
            "bank_account_id": 0,
            "bank_account": {
                "id": 0,
                "bank_connection_id": 0,
                "bank_connection": {
                    "id": 0,
                    "bank_id": 0,
                    "bank": {
                        "id": 0,
                        "integrator": "UNKNOWN",
                        "country": "string",
                        "name": "string",
                        "bic": "string",
                        "logo": "string",
                        "supported": true,
                        "supports_pending_transactions": true,
                        "supports_card_accounts": true,
                        "max_historical_days": 0,
                        "max_access_valid_for_days": 0
                    },
                    "enabled": true,
                    "health": {
                        "status": "HEALTHY",
                        "integrator_message": "string",
                        "failure_count": 0,
                        "last_attempt_at": "2019-08-24T14:15:22Z"
                    },
                    "status": "CR",
                    "status_message": "string",
                    "sync_balances": true,
                    "max_historical_days": 0,
                    "access_valid_for_days": 0,
                    "consent_expires_at": "2019-08-24T14:15:22Z",
                    "accounts_last_synced_at": "2019-08-24T14:15:22Z",
                    "auth_url": "string",
                    "bank_accounts": [
                        {}
                    ],
                    "bank_accounts_count": "string",
                    "created_at": "2019-08-24T14:15:22Z",
                    "updated_at": "2019-08-24T14:15:22Z"
                },
                "config": {
                    "generated": {
                        "payee": "AUTO",
                        "description": "AUTO",
                        "date": "AUTO"
                    },
                    "parse_payee_with_ai": "string",
                    "sync_start_date": "2025-01-01",
                    "sync_auto": true,
                    "sync_pending_transactions": true,
                    "sync_balances": true,
                    "sync_frequency_in_minutes": 0,
                    "fields_for_duplicate_filtering": [
                        "string"
                    ]
                },
                "health": {
                    "status": "HEALTHY",
                    "integrator_message": "string",
                    "failure_count": 0,
                    "last_attempt_at": "2019-08-24T14:15:22Z"
                },
                "integrator": "UNKNOWN",
                "name": "string",
                "display_name": "string",
                "bban": "string",
                "iban": "string",
                "owner_name": "string",
                "currency": "string",
                "product_name": "string",
                "details": "string",
                "msisdn": "string",
                "integrator_id": "string",
                "institution_id": "string",
                "details_last_synced_at": "2019-08-24T14:15:22Z",
                "transactions_last_synced_at": "2019-08-24T14:15:22Z",
                "balances_last_synced_at": "2019-08-24T14:15:22Z",
                "balance": {
                    "available": 0,
                    "cleared": 0
                },
                "rules": "string",
                "transfer_links": [
                    {}
                ],
                "transfer_links_count": "string",
                "created_at": "2019-08-24T14:15:22Z",
                "updated_at": "2019-08-24T14:15:22Z"
            },
            "destination_type": "YNAB",
            "destination_id": 0,
            "destination": {
                "id": 0,
                "budget_id": 0,
                "budget": {
                    "id": 0,
                    "connection_id": 0,
                    "connection": {
                        "id": 0,
                        "health": {
                            "status": "HEALTHY",
                            "integrator_message": "string",
                            "failure_count": 0,
                            "last_attempt_at": "2019-08-24T14:15:22Z"
                        },
                        "enabled": true,
                        "auth_url": "string",
                        "sync_balances": true,
                        "sync_payees": true,
                        "sync_categories": true,
                        "sync_transactions": true,
                        "ynab_user_id": "string",
                        "budgets": [
                            {}
                        ],
                        "last_synced_at": "2019-08-24T14:15:22Z",
                        "created_at": "2019-08-24T14:15:22Z",
                        "updated_at": "2019-08-24T14:15:22Z"
                    },
                    "ynab_id": "string",
                    "enabled": true,
                    "name": "string",
                    "currency": "string",
                    "first_month": "string",
                    "last_month": "string",
                    "accounts": [
                        {}
                    ],
                    "last_synced_at": "2019-08-24T14:15:22Z",
                    "created_at": "2019-08-24T14:15:22Z",
                    "updated_at": "2019-08-24T14:15:22Z"
                },
                "ynab_id": "string",
                "health": {
                    "status": "HEALTHY",
                    "integrator_message": "string",
                    "failure_count": 0,
                    "last_attempt_at": "2019-08-24T14:15:22Z"
                },
                "name": "string",
                "type": "checking",
                "on_budget": true,
                "closed": true,
                "note": "string",
                "balance": "string",
                "cleared_balance": "string",
                "uncleared_balance": "string",
                "transfer_payee_id": "string",
                "direct_import_linked": true,
                "last_reconciled_at": "string",
                "rules": "string",
                "transfer_links": [
                    {}
                ],
                "created_at": "2019-08-24T14:15:22Z",
                "updated_at": "2019-08-24T14:15:22Z"
            },
            "transfer_start_date": "2025-01-01",
            "active": true,
            "on_booked_change": {
                "update_status": true,
                "update_payee": true,
                "update_description": true,
                "update_amount": true
            },
            "rules": "string",
            "created_at": "2019-08-24T14:15:22Z",
            "updated_at": "2019-08-24T14:15:22Z"
        }
    ],
    "links": {
        "first": "string",
        "last": "string",
        "prev": "string",
        "next": "string"
    },
    "meta": {
        "current_page": 0,
        "from": 0,
        "last_page": 0,
        "links": [
            {
                "url": "string",
                "label": "string",
                "active": true
            }
        ],
        "path": "string",
        "per_page": 0,
        "to": 0,
        "total": 0
    }
}
Modified atย 2025-11-18 15:41:51
Previous
Get supported bank
Next
Create a new transfer link
Built with