Welcome to the official reference documentation for Synctera APIs. Our APIs are the best way to automate your company's banking needs and are designed to be easy to understand and implement.
We're continuously growing this library and what you see here is just the start, but if you need something specific or have a question, contact us.
license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html title: Synctera API version: v2 servers: - description: Production url: https://api.synctera.com/v2 - description: Sandbox (no real world financial impact) url: https://api-sandbox.synctera.com/v2 security: - bearerAuth: [] tags: - description: Request to create and manage statements name: Statements - description: Create and manage Cash Order and Cash Deposit transfers name: Cash Orders and Deposits (alpha) - description: Create and manage sweep configurations name: Configs - description: Requests to generate simulated transactions name: Cash Transaction Simulations (alpha) - description: >- Testing endpoints to simulate in-store cash deposits. Available in sandbox environments only. name: In-Store Cash Deposit Simulations - description: Create and manage barcodes for in-store cash deposits name: In-Store Cash Deposits - description: Request to create and manage edd name: Trust - description: Requests to calculate and manage CRR name: CRR - description: Requests to issue and manage cards name: Cards - description: Push and pull from cards name: External Cards - description: Bulk card issuance name: Bulk Issuance - description: Requests to generate simulated transactions name: Card Transaction Simulations - description: Requests to generate simulated webhooks name: Card Webhook Simulations - description: Requests to create and manage card disputes name: Card Disputes - description: Requests to simulate card payments name: Card Simulations - description: Create and manage accounts name: Accounts - description: Create and manage holds name: Hold - description: Create and manage transactions name: Transactions - description: Create and manage transactions name: Transactions (internal) - description: Create and manage scheduled transactions name: Scheduled Transactions (internal) - description: Create and manage spending controls name: Spend Controls - description: Create and manage tenant configurations name: Tenant Configs - description: Lookup merchant information name: Merchants - description: See balance history name: BalanceHistory - description: API for effective balances name: effective_balances - description: Transaction lines API name: transactions - description: Create and manage transactions name: Transactions (beta) - description: Create and manage spending controls name: Spend Controls (beta) - description: | Requests to create and manage fees name: Fees (beta) - description: | Requests to create and manage Rewards name: Rewards (beta) - description: Create and manage disputes name: Disputes - description: Create and manage tenant-level transaction limits name: Tenant Limits (beta) - description: | Requests to create and manage batch payments name: Batch Payments (alpha) - description: Manage negative balance processes name: Negative Balance - description: | Manage fee products and fee configs for automated fee collection name: Fee Products - description: | Manage reward products and reward configs for automated cashback rewards name: Reward Products - description: Request to create and manage deposits using remote deposit capture name: Remote Check Deposit - description: Request to create and manage rdc configurations name: RDC Config - description: Create and manage Synctera Pay templates name: SyncteraPay - description: Apple Pay APIs name: Apple Pay - description: Create a credit application. name: Applications (beta) - description: Billing period summaries name: Billing Period Summaries - description: Customer Service Details for disputes and billing inquiries name: Customer Service Details - description: Billing rates name: Billing Rates - description: Rates name: Rates - description: Lending Config name: Lending Config - description: Manage credit disputes name: Credit Disputes - description: Payments related to lending accounts name: Payments - description: Tenant Config name: Tenant Config - description: Bank Delinquency Configuration name: Bank Delinquency Configuration - description: >- Per bank/partner account-type mapping to FFIEC collateral codes used for regulatory call report furnishment. name: Collateral Code Configuration - description: >- Rules that map a posted payment transaction (bank/partner + transaction attributes) to a regulatory payment code. NULL match columns act as wildcards. name: Payment Code Configuration - description: Autopay configuration management for lending accounts name: Autopay Configs - description: Autopay payment records for billing periods name: Autopays - description: Configuration for mapping LoanPro events to Payola transaction parameters name: LoanPro Transaction Event Config - description: >- Aggregated write-off amounts for lending accounts, computed from posted transactions. name: Write Off Amounts - description: Create and manage wire transfers name: Wires - description: Simulate receiving Wire transactions and returns name: Wire Transaction Simulations - description: >- Create and manage same currency and multi-currency international wire transfers name: International Wires (alpha) - description: Requests for risk evaluation and decisioning name: Risk Evaluations - description: Requests for transaction risk detection name: Transaction risk - description: Configuration and management of transaction monitoring rules name: Transaction Monitoring - description: Request to create and manage payment_schedules name: Cronut - description: Create and manage EFT Canada transfers name: EFT Canada (Beta) - description: FDX authentication and data transfer using Plaid Core Exchange name: Plaid Core Exchange (beta) - description: Configure vendor secrets for egress requests name: Egress Gateway Vendor Secret CRUD API - description: Configure webhook secrets for egress requests name: Egress Gateway Webhook Secret CRUD API - description: Account Template name: Account Templates - description: >- Account programs define configurations for payment rails and transaction capabilities across different account types. name: Account Programs - description: Requests to create and manage account products, including fees, interest. name: Account Products - description: | The internal account resource is used for managing links to internal accounts where the funds are managed by integrators. name: Internal Accounts - description: Requests to create and manage API keys name: API Keys - description: Requests to manage banks name: Banks - description: Requests to create and manage customers name: Customers - description: > A natural person (individual human) that is relevant to the Synctera platform in some way: e.g. a personal customer or a director/officer/owner of a business. name: Persons - description: > A legal entity (corporation, partnership, etc.) that is relevant to the Synctera platform in some way: a business customer or some other organization that has an ownership share in such a business customer. name: Businesses - description: > The fintech profile document resource is used to track the approval status of any documents which must be reviewed by a bank. This includes regulatory documents which will be presented to the fintech's end users, and also any documents that help the bank understand the fintech's fitness for duty. name: Fintech Profile - description: | The disclosures resource is used to track the status of disclosures and ensure that all parties have been shown the necessary disclosures to meet regulatory obligations. name: Disclosures - description: | The Disclosures resource is used to track the status of disclosures and ensure that customers have been shown the necessary disclosures to meet regulatory obligations. name: Disclosures (deprecated) - description: | The External Account resource is used for managing links to accounts that operate outside of the Synctera ecosystem. name: External Accounts - description: History name: History - description: Requests to initiate customer verification. name: KYC Verification (deprecated) - description: Requests to initiate customer verification. name: KYC/KYB Verifications - description: Requests to screen parties against sanctions watchlists name: Sanctions Screening - description: Requests to manage monitoring subscriptions and alerts for customers. name: Monitoring - description: Requests to manage partners name: Partners - description: Request to create and manage party groups and party group members name: Party Groups - description: Requests to create and manage roles name: Roles - description: > Represents the relationships between parties. A relationship can exist between personal customers, business customers, or non-customer persons/organizations. name: Relationships - description: Request to create and manage users name: Users - description: Request to enroll, renew, or cancel watchlist monitors name: Watchlist (deprecated) - description: Retrieve user identity information name: Identity - description: Endpoints for modifying or fetching posting dates name: Posting Dates - description: Admin API for Middesk configuration using the tenants API keys. name: Middesk - description: Requests to search and manage compliance searches name: Compliance Searches - description: Requests to configure vendors. name: Vendor Configurations - description: Requests to create and manage notes name: Notes - description: > Represents the compliance rules that are used to verify certain kinds of money movement. name: Compliance Rules - description: Requests to create licenses name: Licenses - description: >- Used to configure bank accounts for which synctera accounts are considered a "subledger" to name: Bank Account - description: Requests to search financial institutions name: Institutions (Beta) - description: Requests to manage addresses name: Addresses - description: Requests to Admins to grant permissions to user name: Request Permissions - description: Manage contacts for bank and fintech partners name: Contacts - description: Requests to create and manage personal ID configurations name: Personal ID Configuration - description: >- Migration mappings associate resources from an old tenant identity with a new tenant identity. name: Migration Mappings - description: Create and manage payments name: ACH - description: Simulate receiving ACH transactions and returns name: ACH Transaction Simulations - description: Requests to create and manage webhooks name: Webhooks - description: Create and manage documents. name: Documents paths: /accounts/templates/{template_id}: summary: account get: tags: - Accounts summary: Get account template description: Get an account template operationId: getAccountTemplate parameters: - $ref: '#/components/parameters/template_id' responses: '200': content: application/json: schema: $ref: '#/components/schemas/account_template_response' description: Account Template components: parameters: template_id: description: Account Template ID in: path name: template_id required: true schema: example: a8943c51-e4ff-4e57-9558-08cab6b963c0 format: uuid type: string schemas: account_template_response: properties: application_type: $ref: '#/components/schemas/application_type' description: description: Account template description type: string id: description: Generated ID for the template format: uuid type: string is_enabled: description: Whether this template can be used for account creation type: boolean name: description: Unique account template name type: string template: $ref: '#/components/schemas/template_fields_generic_response' tenant: $ref: '#/components/schemas/tenant_id' required: - name - is_enabled - template type: object application_type: description: > The type of the application to require. * CREDIT: Credit application * LINE_OF_CREDIT: (Deprecated) Line of credit application (if provided, this will be converted to a CREDIT type in the response) * RESTRICTED_ACCOUNT: restricted account application enum: - CREDIT - LINE_OF_CREDIT - RESTRICTED_ACCOUNT title: Application Type type: string template_fields_generic_response: properties: account_program_id: format: uuid type: string x-go-type: openapi_types.UUID account_type: $ref: '#/components/schemas/account_type' application_workflow_id: description: Taktile workflow ID for credit application processing format: uuid type: string auto_payment_period: description: > The number of days past the billing period to initiate an auto payment. Only applicable for accounts with type `CHARGE_SECURED`, where the account holder has opted in for auto payment functionality. This value must be lower than or equal to the `grace_period` setting on the account. If this value is 0, the auto payment will happen on the same day as the statement is generated. Auto payment only occurs if regular payments are not received on time. example: 20 maximum: 28 minimum: 0 type: integer balance_ceiling: $ref: '#/components/schemas/balance_ceiling' balance_floor: $ref: '#/components/schemas/balance_floor' bank_account_id: description: > The bank account ID for this account. This is a unique identifier for the bank side account that this Synctera account belongs to. This field can be auto filled if only one bank account of the appropriate type exist for the tenant of concern. format: uuid type: string bank_country: description: Bank country of the account example: US pattern: ^[A-Z]{2,3}$ type: string billing_period: $ref: '#/components/schemas/billing_period' currency: description: Account currency. ISO 4217 alphabetic currency code example: USD pattern: ^[A-Z]{3}$ type: string fee_product_ids: description: >- A list of fee account products that the current account associates with. items: format: uuid type: string nullable: true type: array grace_period: $ref: '#/components/schemas/grace_period' interest_product_id: description: >- An interest account product that the current account associates with. format: uuid type: string is_ach_credit_enabled: description: >- Enable ACH credits on the ledger. Both is_ach_enabled and is_ach_credit_enabled must be true for an ACH credit to be allowed. type: boolean is_ach_debit_enabled: description: >- Enable ACH debits on the ledger. Both is_ach_enabled and is_ach_debit_enabled must be true for an ACH debit to be allowed. type: boolean is_ach_enabled: default: false description: Enable ACH transaction on ledger. type: boolean is_card_credit_enabled: description: >- Enable card credits on the ledger. Both is_card_enabled and is_card_credit_enabled must be true for a card credit to be allowed. type: boolean is_card_debit_enabled: description: >- Enable card debits on the ledger. Both is_card_enabled and is_card_debit_enabled must be true for a card debit to be allowed. type: boolean is_card_enabled: default: false description: Enable card transaction on ledger. type: boolean is_cash_credit_enabled: description: >- Enable cash credits on the ledger. Both is_cash_enabled and is_cash_credit_enabled must be true for a cash credit to be allowed. type: boolean is_cash_debit_enabled: description: >- Enable cash debits on the ledger. Both is_cash_enabled and is_cash_debit_enabled must be true for a cash debit to be allowed. type: boolean is_cash_enabled: default: false description: Enable cash transaction on ledger. type: boolean is_check_credit_enabled: description: >- Enable check credits on the ledger. Both is_check_enabled and is_check_credit_enabled must be true for a check credit to be allowed. type: boolean is_check_debit_enabled: description: >- Enable check debits on the ledger. Both is_check_enabled and is_check_debit_enabled must be true for a check debit to be allowed. type: boolean is_check_enabled: default: false description: Enable check transaction on ledger. type: boolean is_eft_ca_credit_enabled: description: >- Enable EFT Canada credits on the ledger. Both is_eft_ca_enabled and is_eft_ca_credit_enabled must be true for an EFT Canada credit to be allowed. type: boolean is_eft_ca_debit_enabled: description: >- Enable EFT Canada debits on the ledger. Both is_eft_ca_enabled and is_eft_ca_debit_enabled must be true for an EFT Canada debit to be allowed. type: boolean is_eft_ca_enabled: description: A flag to indicate whether EFT Canada transactions are enabled. type: boolean is_external_card_credit_enabled: description: >- Enable external card credits on the ledger. Both is_external_card_enabled and is_external_card_credit_enabled must be true for an external card credit to be allowed. type: boolean is_external_card_debit_enabled: description: >- Enable external card debits on the ledger. Both is_external_card_enabled and is_external_card_debit_enabled must be true for an external card debit to be allowed. type: boolean is_external_card_enabled: default: false description: Enable external card transaction on ledger. type: boolean is_fednow_credit_enabled: description: >- A flag to indicate whether FedNow credits are enabled. Both is_fednow_enabled and is_fednow_credit_enabled must be true for a FedNow credit to be allowed. readOnly: true type: boolean is_fednow_debit_enabled: description: >- A flag to indicate whether FedNow debits are enabled. Both is_fednow_enabled and is_fednow_debit_enabled must be true for a FedNow debit to be allowed. readOnly: true type: boolean is_fednow_enabled: description: A flag to indicate whether FedNow transactions are enabled. readOnly: true type: boolean is_p2p_enabled: default: false description: Enable P2P transaction on ledger. type: boolean is_sar_enabled: default: false description: Enable SAR report. type: boolean is_synctera_pay_credit_enabled: description: >- Enable Synctera Pay credits on the ledger. Both is_synctera_pay_enabled and is_synctera_pay_credit_enabled must be true for a Synctera Pay credit to be allowed. type: boolean is_synctera_pay_debit_enabled: description: >- Enable Synctera Pay debits on the ledger. Both is_synctera_pay_enabled and is_synctera_pay_debit_enabled must be true for a Synctera Pay debit to be allowed. type: boolean is_synctera_pay_enabled: default: false description: Enable Synctera Pay transaction on ledger. type: boolean is_wire_credit_enabled: description: >- Enable wire credits on the ledger. Both is_wire_enabled and is_wire_credit_enabled must be true for a wire credit to be allowed. type: boolean is_wire_debit_enabled: description: >- Enable wire debits on the ledger. Both is_wire_enabled and is_wire_debit_enabled must be true for a wire debit to be allowed. type: boolean is_wire_enabled: default: false description: Enable wire transaction on ledger. type: boolean minimum_payment: $ref: '#/components/schemas/minimum_payment' overdraft_limit: deprecated: true description: | This field is unused and will be removed in a future API version. format: int64 minimum: 0 type: integer reward_product_ids: description: >- A list of reward account products that the current account associates with. items: format: uuid type: string nullable: true type: array spend_control_ids: $ref: '#/components/schemas/spend_control_ids' spending_limits: $ref: '#/components/schemas/spending_limits' vendor_info: $ref: '#/components/schemas/template_vendor_info' required: - account_type - currency - bank_country type: object tenant_id: description: > The id of the tenant containing the resource. This is relevant for Fintechs that have multiple workspaces. example: abcdef_ghijkl type: string account_type: description: > The type of the account. In lead mode, this always takes the value of the template. If not specified in shadow mode, CHECKING will be assumed. Below mentioned are the account types: * SAVING: Savings account * CHECKING: Checking account * PREPAID: Prepaid account * LINE_OF_CREDIT: Line of Credit account * CREDIT_CARD: Credit Card account * CHARGE_SECURED: Secured Charge account, e.g. for use in a Smart Charge Card offering * CHARGE_UNSECURED: (alpha) Unsecured Charge account * REVOLVING_CREDIT_SECURED: Secured Revolving Credit account * REVOLVING_CREDIT_UNSECURED: Unsecured Revolving Credit account * GENERAL_LEDGER: General Ledger account (alpha - cannot yet be created). In production, these can only be created or updated by a Synctera administrator. enum: - SAVING - CHECKING - PREPAID - LINE_OF_CREDIT - CREDIT_CARD - CHARGE_SECURED - CHARGE_UNSECURED - REVOLVING_CREDIT_SECURED - REVOLVING_CREDIT_UNSECURED - GENERAL_LEDGER title: Account Type type: string balance_ceiling: properties: balance: description: Maximum balance in the account's currency. Unit in cents. format: int64 minimum: 0 type: integer linked_account_id: description: > ID of linked backing account for just-in-time (JIT) funding of transactions to maintain the balance ceiling format: uuid type: string overflow_account_id: deprecated: true description: > ID of linked backing account for just-in-time (JIT) funding of transactions to maintain the balance ceiling This attribute is a deprecated alias for linked_account_id. format: uuid type: string required: - balance type: object balance_floor: properties: balance: description: Minimum balance in the account's currency. Unit in cents. format: int64 type: integer linked_account_id: description: > ID of linked backing account for just-in-time (JIT) funding of transactions to maintain the balance floor format: uuid type: string overdraft_account_id: deprecated: true description: > ID of linked backing account for just-in-time (JIT) funding of transactions to maintain the balance floor This attribute is a deprecated alias for linked_account_id. format: uuid type: string required: - balance type: object billing_period: description: | The scheme for determining an account's billing period. properties: frequency: $ref: '#/components/schemas/billing_frequency' start_date: description: > The first day of the first billing cycle for this account. For a monthly billing cycle, this would determine the day of the month each billing cycle will start on. Note that, although this is returned as a UTC timestamp, the date always corresponds to the bank's calendar, and therefore the time and timezone should be ignored. example: '2022-01-01T00:00:00Z' format: date-time type: string required: - start_date - frequency type: object grace_period: description: > The number of days past the billing period to allow for payment before it is considered due. This directly determines the due date for a payment. minimum: 1 type: integer minimum_payment: description: > The scheme for calculating the minimum payment due for outstanding balances in a billing period. discriminator: mapping: FULL: $ref: '#/components/schemas/minimum_payment_type_full' RATE_OR_AMOUNT: $ref: '#/components/schemas/minimum_payment_type_rate_or_amount' propertyName: type oneOf: - $ref: '#/components/schemas/minimum_payment_type_rate_or_amount' - $ref: '#/components/schemas/minimum_payment_type_full' type: object spend_control_ids: description: List of spend control IDs to control spending for the account items: example: 7d943c51-e4ff-4e57-9558-08cab6b963c7 format: uuid type: string maxItems: 100 type: array spending_limits: deprecated: true description: >- Account spending limits is unused and has been deprecated. Instead use the spend controls API. properties: day: $ref: '#/components/schemas/spending_limit_with_time' description: description: User provided description on the spending limits type: string lifetime: $ref: '#/components/schemas/spending_limit_with_time' month: $ref: '#/components/schemas/spending_limit_with_time' transaction: description: Individual transaction limit properties: amount: description: Maximum amount allowed. Unit in cents. format: int64 minimum: 0 type: integer type: object week: $ref: '#/components/schemas/spending_limit_with_time' type: object template_vendor_info: description: Vendor information for account templates properties: vendor_data: $ref: '#/components/schemas/template_vendor_data' vendor_type: $ref: '#/components/schemas/vendor_type' required: - vendor_type - vendor_data type: object billing_frequency: description: > The frequency of billing cycles. Along with the start date, this will determine the start and end of each cycle. enum: - ANNUALLY - MONTHLY - SEMI_MONTHLY - BI_WEEKLY - WEEKLY - DAILY type: string minimum_payment_type_full: properties: type: $ref: '#/components/schemas/minimum_payment_type' required: - type type: object minimum_payment_type_rate_or_amount: properties: min_amount: description: > The minimum amount to charge as a minimum payment, in cents. For example, to set the minimum to $30, set this value to 3000. Note: despite setting this value, the minimum payment will never be greater than the statement balance. format: int64 type: integer rate: description: > The percentage of the balance to use, in basis points. For example, to set 12.5% of the balance, set this value to 1250. type: integer type: $ref: '#/components/schemas/minimum_payment_type' required: - type - rate - min_amount type: object spending_limit_with_time: description: Limit over a specific time period. properties: amount: description: Maximum amount allowed within the time range. Unit in cents. format: int64 minimum: 0 type: integer transactions: description: Maximum number of transactions allowed within the time range format: int64 minimum: 0 type: integer type: object template_vendor_data: description: Vendor-specific data for templates properties: loanpro: $ref: '#/components/schemas/loanpro_template_vendor_data' type: object vendor_type: description: The type of vendor managing this account enum: - LOANPRO example: LOANPRO type: string minimum_payment_type: description: > * RATE_OR_AMOUNT: Describes a minimum payment scheme where the amount calculated is either a portion of the balance due, or a fixed, minimum amount, whichever is greater. For example, if set to 1.00% and $30, the minimum payment will be calculated as 1.00% of the balance, or $30, whichever is greatest. However, the minimum payment will never exceed the statement balance. * FULL: Describes a minimum payment scheme where the amount calculated is the entire account balance at the end of the statement period. Note that the choice of minimum payment type is constrained by the account type. enum: - RATE_OR_AMOUNT - FULL type: string loanpro_template_vendor_data: description: LoanPro-specific vendor data for template properties: cash_advance_bucket_id: description: LoanPro cash advance bucket ID example: 67890 format: int64 minimum: 1 type: integer loc_product_id: description: LoanPro line of credit product ID example: 67890 format: int64 minimum: 1 type: integer purchases_bucket_id: description: LoanPro purchases bucket ID example: 12345 format: int64 minimum: 1 type: integer tenant_id: description: LoanPro tenant ID example: '1' minLength: 1 type: string required: - loc_product_id - tenant_id - purchases_bucket_id - cash_advance_bucket_id type: object securitySchemes: bearerAuth: bearerFormat: api_key scheme: bearer type: http ````