Synci API
  1. TransferLinks
Synci API
  • BankAccounts
    • List all bank accounts
      GET
    • Get bank account
      GET
    • Update bank account
      PUT
    • Delete bank account
      DELETE
    • Sync bank account data
      POST
    • 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
  • 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 budget
    • List all YNAB budget accounts
    • Get YNAB budget account
    • Delete YNAB budget account
  • YnabConnections
    • List all YNAB connections
    • Create new YNAB connection
    • Get YNAB connection
    • Delete YNAB connection
  • LunchMoneyConnections
    • List all Lunch Money connections
    • Create new Lunch Money connection
    • Get Lunch Money connection
    • Delete Lunch Money connection
    • Update Lunch Money connection
    • List all Lunch Money accounts
    • Get Lunch Money account
    • Delete Lunch Money account
  • WebhookEndpoints
    • List all webhook events
    • List all webhook endpoints
    • Create new webhook endpoint
    • Get webhook endpoint
    • Update webhook endpoint
    • Delete webhook endpoint
    • Test webhook endpoint
    • Rotate webhook secret
  • Schemas
    • BalanceTypeEnum
    • BankAccount
    • BankAccountResource
    • BankBalanceResource
    • BankConfigGeneratedDateEnum
    • BankConfigGeneratedTextEnum
    • BankConfigResource
    • BankConnectionResource
    • BankIntegratorEnum
    • BankResource
    • BankTransactionResource
    • BulkUndoTransferLogsRequest
    • CreateBankConnectionRequest
    • CreateBankTransactionRequest
    • CreateRuleRequest
    • CreateTransferLinkRequest
    • CreateLunchMoneyConnectionRequest
    • DestinationTypeEnum
    • CreateWebhookEndpointRequest
    • HealthResource
    • HealthStatusEnum
    • ReauthorizeBankConnectionRequest
    • LunchMoneyAccountResource
    • RetryTransfersAllLinksRequest
    • LunchMoneyConnectionResource
    • RetryTransfersRequest
    • RuleActionResource
    • RuleActionTypeEnum
    • RuleConditionResource
    • RuleLogResource
    • RuleOperatorEnum
    • RuleResource
    • RuleTypeEnum
    • SourceTypeEnum
    • TransactionTypeEnum
    • TransferLink
    • TransferLinkResource
    • SyncBankAccountRequest
    • TransferLogResource
    • TestWebhookRequest
    • TransferLogStatusEnum
    • UpdateBankAccountRequest
    • UpdateBankTransactionRequest
    • UpdateRuleRequest
    • UpdateTransferLinkRequest
    • UpdateYnabBudgetRequest
    • UpdateLunchMoneyConnectionRequest
    • YnabBudgetAccountResource
    • YnabBudgetAccountTypeEnum
    • YnabBudgetResource
    • UpdateWebhookEndpointRequest
    • YnabConnectionResource
    • WebhookEndpointResource
    • WebhookEventResource
    • WebhookEventTypeEnum
    • WebhookTypeEnum
  1. TransferLinks

Get transfer link

GET
/transfer-links/{transferLinkId}

Request

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

Responses

๐ŸŸข200OK
application/json
TransferLinkResource
Body

Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.synci.io/api/v1/transfer-links/' \
--header 'Authorization: Bearer <token>'
Response Response Example
{
    "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:22.123Z"
                },
                "status": "string",
                "status_message": "string",
                "sync_balances": true,
                "max_historical_days": 0,
                "access_valid_for_days": 0,
                "consent_expires_at": "2019-08-24T14:15:22.123Z",
                "accounts_last_synced_at": "2019-08-24T14:15:22.123Z",
                "auth_url": "string",
                "bank_accounts": [
                    {}
                ],
                "bank_accounts_count": "string",
                "created_at": "2019-08-24T14:15:22.123Z",
                "updated_at": "2019-08-24T14:15:22.123Z"
            },
            "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:22.123Z"
            },
            "enabled": true,
            "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:22.123Z",
            "transactions_last_synced_at": "2019-08-24T14:15:22.123Z",
            "balances_last_synced_at": "2019-08-24T14:15:22.123Z",
            "balance": {
                "available": null,
                "cleared": null
            },
            "rules": "string",
            "transfer_links": [
                {}
            ],
            "transfer_links_count": "string",
            "created_at": "2019-08-24T14:15:22.123Z",
            "updated_at": "2019-08-24T14:15:22.123Z"
        },
        "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:22.123Z"
                    },
                    "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:22.123Z",
                    "created_at": "2019-08-24T14:15:22.123Z",
                    "updated_at": "2019-08-24T14:15:22.123Z"
                },
                "ynab_id": "string",
                "enabled": true,
                "name": "string",
                "currency": "string",
                "first_month": "string",
                "last_month": "string",
                "accounts": [
                    {}
                ],
                "last_synced_at": "2019-08-24T14:15:22.123Z",
                "created_at": "2019-08-24T14:15:22.123Z",
                "updated_at": "2019-08-24T14:15:22.123Z"
            },
            "ynab_id": "string",
            "health": {
                "status": "HEALTHY",
                "integrator_message": "string",
                "failure_count": 0,
                "last_attempt_at": "2019-08-24T14:15:22.123Z"
            },
            "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:22.123Z",
            "updated_at": "2019-08-24T14:15:22.123Z"
        },
        "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:22.123Z",
        "updated_at": "2019-08-24T14:15:22.123Z"
    }
}
Modified atย 2026-02-12 21:58:29
Previous
Create a new transfer link
Next
Update transfer link
Built with