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: 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: Create and manage payments name: ACH - description: Simulate receiving ACH transactions and returns name: ACH Transaction Simulations - 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: Create and manage documents. name: Documents - description: Create and manage EFT Canada transfers name: EFT Canada (Beta) - description: Create and manage sweep configurations name: Configs - 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 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: 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: 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 deposits using remote deposit capture name: Remote Check Deposit - description: Request to create and manage rdc configurations name: RDC Config - description: Apple Pay APIs name: Apple Pay - description: Requests to create and manage webhooks name: Webhooks - 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: Create and manage Cash Order and Cash Deposit transfers name: Cash Orders and Deposits (alpha) - description: FDX authentication and data transfer using Plaid Core Exchange name: Plaid Core Exchange (beta) - description: Request to create and manage payment_schedules name: Cronut - description: Request to create and manage statements name: Statements - description: Create and manage Synctera Pay templates name: SyncteraPay - 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 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 paths: /internal_accounts/{internal_account_id}: summary: Internal Accounts get: tags: - Internal Accounts summary: Get internal account by id description: | Returns an internal account by id operationId: getInternalAccounts parameters: - $ref: '#/components/parameters/internal_account_id_path' responses: '200': content: application/json: schema: $ref: '#/components/schemas/internal_account_response' description: Internal Account '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '500': $ref: '#/components/responses/internal_server_error' components: parameters: internal_account_id_path: description: Unique identifier for the internal account. in: path name: internal_account_id required: true schema: example: 7d943c51-e4ff-4e57-9558-08cab6b963c7 format: uuid type: string schemas: internal_account_response: allOf: - properties: tenant: $ref: '#/components/schemas/tenant_id' - $ref: '#/components/schemas/internal_account' type: object tenant_id: description: | The id of the tenant containing the resource. example: abcdef_ghijkl type: string internal_account: properties: account_number: description: Generated internal account number readOnly: true type: string account_type: $ref: '#/components/schemas/internal_account_type' balances: description: A list of balances for internal account based on different type items: $ref: '#/components/schemas/balance' readOnly: true type: array bank_account_id: description: > The ID of the bank account associated with this internal account. It will be auto-filled if the account type has only one matching bank account in the system. format: uuid type: string bank_routing: description: Bank routing number maxLength: 9 readOnly: true type: string creation_time: description: The date and time the resource was created. example: '2010-05-06T12:23:34.321Z' format: date-time readOnly: true type: string currency: description: >- Account currency or account settlement currency. ISO 4217 alphabetic currency code. example: USD pattern: ^[A-Z]{3}$ type: string description: description: A user provided description for the current account type: string gl_type: description: > What type of general ledger account this internal account represents. enum: - ASSET - LIABILITY - EXPENSE - REVENUE type: string id: description: Generated ID for internal account format: uuid readOnly: true type: string is_system_acc: default: false description: >- Is a system-controlled internal account. When this field is true, this internal account will be reserved exclusively for internal use by the Synctera platform and any internal transfers to or from this internal account will be declined. type: boolean last_updated_time: description: The date and time the resource was last updated. example: '2010-05-06T12:23:34.321Z' format: date-time readOnly: true type: string purpose: $ref: '#/components/schemas/internal_account_purpose' skip_sweeps: description: > Indicates if transactions of this internal account should be skipped by our sweeps system. type: boolean status: enum: - ACTIVE type: string required: - status - currency type: object error: description: Synctera error responses in API v1 implement a custom error schema. properties: code: description: > A machine-readable string that identifies the error for programmatic use. example: BAD_REQUEST_BODY type: string detail: description: | A human-readable string explaining this particular error. example: 'Missing required fields: first_name, dob' type: string status: description: HTTP status code for this response example: 400 type: integer title: Synctera error response type: object internal_account_type: description: type associated with the internal account. enum: - ACH_SETTLEMENT - ACH_SUSPENSE - ALLOCATED_SUSPENSE - BANK_DRAFT - BILLING_EXPENSE - BILLING_REVENUE - CARD_AFT_PREFUNDING - CARD_OCT_SETTLEMENT - CARD_SETTLEMENT - CASH_SETTLEMENT - CASH_SUSPENSE - CHECK_SETTLEMENT - DISPUTE_WRITE_OFF_PNL - EFT_CA_SETTLEMENT - EFT_CA_SUSPENSE - EXTERNAL_CARD_AFT_SETTLEMENT - EXTERNAL_CARD_OCT_SETTLEMENT - FEDNOW_SETTLEMENT - FEES - FRAUD_LOSSES - FUNDING_ACCOUNTS - GENERAL_PNL - IN_STORE_CASH_SETTLEMENT - INTEREST_PAYOUT - INTERNATIONAL_WIRE_SETTLEMENT - LOC_INTEREST_INCOME - LOC_INVESTOR_PORTFOLIO - LOC_REPURCHASE - MONEY_IN_AND_OUT - NEGATIVE_BALANCE - NETWORK_ADJUSTMENT - NETWORK_CHARGEBACK - NEW_FUNDING_ACCOUNT - PROVISIONAL_CREDIT_PNL - RESERVE - REWARDS - SC_INVESTOR_PORTFOLIO - SC_REPURCHASE - SYNCTERA_PAY_SUSPENSE - USC_INTEREST_INCOME - USC_INVESTOR_PORTFOLIO - USC_REPURCHASE - WIRE_SETTLEMENT - WIRE_SUSPENSE - WRITE_OFF type: string balance: properties: balance: description: balance in ISO 4217 minor currency units. Unit in cents. example: 2399 format: int64 readOnly: true type: integer type: $ref: '#/components/schemas/balance_type' required: - type - balance type: object internal_account_purpose: description: >- The purpose of the internal account. On creation, the default is PROFIT_AND_LOSS. enum: - PROFIT_AND_LOSS - CORE - RESERVE - SETTLEMENT - TREASURY - SUSPENSE type: string balance_type: description: > * `ACCOUNT_BALANCE`: The posted balance of the account. For a banking account, e.g. `CHECKING` or `SAVING`, this is a measure of the sum of credits minus debits for all posted transactions. For a lending account, e.g. `CHARGE_SECURED` or `LINE_OF_CREDIT`, this is a measure of the sum of debits minus credits for all posted transactions. This value can be negative. * `AVAILABLE_BALANCE`: The available balance of the account, which is the amount available to spend, or the spending power. For a banking account, e.g. `CHECKING` or `SAVING`, this is a measure of the account balance minus any pending debits. For an unsecured lending account, e.g. `CHARGE_UNSECURED` or `LINE_OF_CREDIT`, this is a measure of available credit, which is its credit limit minus the account balance, minus any pending debits. For a `CHARGE_SECURED` account, it equals the `AVAILABLE_BALANCE` of the linked security account. This value will never be negative. * `ACCRUED_INTEREST_MTD`: The amount of accrued but unposted interest. This value may fluctuate, as new transactions can affect interest amounts. Treat accrued interest as pending for the billing month until it is posted at the end of the billing period. * `PAYMENTS_RECEIVED_MTD`: The amount of payment received to date for the billing month. enum: - ACCOUNT_BALANCE - AVAILABLE_BALANCE - ACCRUED_INTEREST_MTD - PAYMENTS_RECEIVED_MTD type: string responses: unauthorized: content: application/json: schema: $ref: '#/components/schemas/error' description: Unauthorized forbidden: content: application/json: schema: $ref: '#/components/schemas/error' description: Forbidden internal_server_error: content: application/json: schema: $ref: '#/components/schemas/error' description: Internal server error securitySchemes: bearerAuth: bearerFormat: api_key scheme: bearer type: http ````