Synci API
  1. BankTransactions
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
      GET
    • Create a new rule action
      POST
    • Get rule action
      GET
    • Update rule action
      PUT
    • Delete rule action
      DELETE
  • RuleConditions
    • List rule conditions
      GET
    • Create a new rule condition
      POST
    • Get rule condition
      GET
    • Update rule condition
      PUT
    • Delete rule condition
      DELETE
  • 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
    • Create a new transfer link
    • Get transfer link
    • Update transfer link
    • Delete transfer link
    • Retry transfers for all transfer links
    • Retry transfers for a specific transfer link
  • 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. BankTransactions

List all bank transactions

GET
/banks/transactions
To improve efficiency and developer experience, most empty transaction fields are omitted from the response.
Fields that are marked as required in the API specification are always included, even if they are empty.

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
Array of BankTransactionResource
Body

๐ŸŸ 401Unauthorized
๐ŸŸ 403Forbidden
๐ŸŸ 422Unprocessable Entity
Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request GET 'https://api.synci.io/api/v1/banks/transactions?generate_fields&sort&include&page[size]&page[number]&filter[bank_account.name]&filter[bank_account.display_name]&filter[bank_account.bban]&filter[bank_account.iban]&filter[debtor.bban]&filter[debtor.iban]&filter[creditor.bban]&filter[creditor.iban]&filter[creditor.name]&filter[debtor.name]&filter[external_identifiers.institution_transaction_id]&filter[remittance_information.structured]&filter[remittance_information.unstructured]&filter[remittance_information.structured_array]&filter[remittance_information.unstructured_array]&filter[bank_account_id]&filter[booked]&filter[currency]&filter[additional_information]&filter[additional_information_structured]&filter[additional_data_structured]&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": [
                    {
                        "id": 0,
                        "bank_account_id": 0,
                        "bank_account": {},
                        "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"
                    }
                ],
                "transfer_links_count": "string",
                "created_at": "2019-08-24T14:15:22Z",
                "updated_at": "2019-08-24T14:15:22Z"
            },
            "amount": "string",
            "currency": "string",
            "booked": true,
            "generated": {
                "date": "string",
                "payee": "string",
                "description": "string"
            },
            "ai": {
                "payee": "string"
            },
            "booking_date": "2019-08-24T14:15:22Z",
            "booking_datetime": 0,
            "value_date": "2019-08-24T14:15:22Z",
            "value_datetime": 0,
            "debtor": {
                "name": "string",
                "bban": "string",
                "iban": "string",
                "pan": "string",
                "masked_pan": "string",
                "msisdn": "string",
                "currency": "string",
                "agent": "string"
            },
            "creditor": {
                "name": "string",
                "bban": "string",
                "iban": "string",
                "id": "string",
                "pan": "string",
                "masked_pan": "string",
                "msisdn": "string",
                "currency": "string",
                "agent": "string"
            },
            "ultimate_debtor": "string",
            "ultimate_creditor": "string",
            "remittance_information": {
                "structured": "string",
                "structured_array": "string",
                "unstructured": "string",
                "unstructured_array": "string"
            },
            "additional_data_structured": "string",
            "additional_information": "string",
            "additional_information_structured": "string",
            "balance_after_transaction": "string",
            "codes": {
                "bank_transaction_code": "string",
                "merchant_category_code": "string",
                "proprietary_bank_transaction_code": "string",
                "purpose_code": "string"
            },
            "currency_exchange": {
                "source_currency": "string",
                "exchange_rate": "string",
                "unit_currency": "string",
                "target_currency": "string",
                "quotation_date": "string",
                "contract_identification": "string"
            },
            "external_identifiers": {
                "institution_transaction_id": "string",
                "integrator_transaction_id": "string",
                "end_to_end_id": "string",
                "entry_reference": "string",
                "check_id": "string",
                "mandate_id": "string"
            },
            "transfer_logs": [
                {
                    "id": 0,
                    "transfer_link_id": 0,
                    "transfer_link": {
                        "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"
                    },
                    "bank_transaction_id": 0,
                    "bank_transaction": {},
                    "destination_transaction_id": "string",
                    "status": "SCHEDULED",
                    "message": "string",
                    "created_at": "2019-08-24T14:15:22Z",
                    "updated_at": "2019-08-24T14:15:22Z"
                }
            ],
            "created_at": "2019-08-24T14:15:22Z",
            "updated_at": "2019-08-24T14:15:22Z"
        }
    ],
    "meta": {
        "available_bank_accounts": [
            {
                "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": [
                    {
                        "id": 0,
                        "bank_account_id": 0,
                        "bank_account": {},
                        "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"
                    }
                ],
                "transfer_links_count": "string",
                "created_at": "2019-08-24T14:15:22Z",
                "updated_at": "2019-08-24T14:15:22Z"
            }
        ]
    }
}
Modified atย 2025-11-18 15:41:51
Previous
Reconfirm the consent of a bank connection
Next
Create a new bank transaction
Built with