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: /disclosures/{disclosure_id}: get: tags: - Disclosures summary: Get disclosure description: Get disclosure by ID. operationId: getDisclosure parameters: - $ref: '#/components/parameters/disclosure_id' responses: '200': content: application/json: schema: $ref: '#/components/schemas/disclosure' description: Disclosure representation. '400': $ref: '#/components/responses/bad_request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not_found' '500': $ref: '#/components/responses/internal_server_error' components: parameters: disclosure_id: description: The unique identifier for the disclosure. in: path name: disclosure_id required: true schema: example: 7d943c51-e4ff-4e57-9558-08cab6b963c7 format: uuid type: string schemas: disclosure: allOf: - required: - type - version - event_type - disclosure_date - $ref: '#/components/schemas/base_disclosure' description: Represents a disclosure. type: object base_disclosure: properties: acknowledging_person_id: description: >- Unique ID for the person acknowledging the disclosure. Applicable for disclosures where the person acknowledging is different from the subject of the disclosure. Required for OWNER_CERTIFICATION disclosures. example: 7d943c51-e4ff-4e57-9558-08cab6b963c7 format: uuid type: string business_id: $ref: '#/components/schemas/business_id' 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 disclosure_date: description: Date and time the disclosure was made. example: '2010-05-06T12:23:34.321Z' format: date-time type: string document_id: description: ID of disclosure document. example: 7d943c51-e4ff-4e57-9558-08cab6b963c7 format: uuid type: string event_type: description: >- Describes how the disclosure was shown and what the user did as a result. One of the following: * `DISPLAYED` — The document was made visible to the user, but they did not interact with it. * `VIEWED` — The document was made visible to the user, and they interacted enough to see the whole document (e.g. scrolled to the bottom). * `ACKNOWLEDGED` — The document was made visible to the user, and they took positive action to confirm that they have read and accepted the document. enum: - DISPLAYED - VIEWED - ACKNOWLEDGED example: ACKNOWLEDGED type: string id: $ref: '#/components/schemas/id' 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 metadata: $ref: '#/components/schemas/metadata' person_id: $ref: '#/components/schemas/person_id' tenant: $ref: '#/components/schemas/tenant_id' type: $ref: '#/components/schemas/disclosure_type' version: $ref: '#/components/schemas/version' 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 business_id: description: >- Business ID for the application. An application must have either a Business or a customer associated with it. example: 7d943c51-e4ff-4e57-9558-08cab6b963c7 format: uuid type: string id: description: The unique identifier for this resource. example: 7d943c51-e4ff-4e57-9558-08cab6b963c7 format: uuid readOnly: true type: string metadata: description: > Optional field to store additional information about the resource. Intended to be used by the integrator to store non-sensitive data. type: object person_id: description: > Unique ID for the person. Exactly one of `person_id` or `business_id` must be set. example: 7d943c51-e4ff-4e57-9558-08cab6b963c7 format: uuid type: string tenant_id: description: | The id of the tenant containing the resource. example: abcdef_ghijkl type: string disclosure_type: description: >- Describes the regulatory requirement that triggered the disclosure. One of the following: * `ACH_AUTHORIZATION` – [US] The ACH Authorization & Agreement Disclosure serves as a method of disclosing and obtaining consent from a consumer to conduct ACH and pre-authorized electronic transactions to and from their account. Record of obtaining this consent should be retained, in accordance with Reg E, for no less than 2 years from the date the disclosure was made to the consumer. * `DIRECT_BILLING_AUTHORIZATION` – [US] Disclosure to certify that the user has authorized Synctera to initiate ACH debits/credits to the specified settlement account. * `CARDHOLDER_AGREEMENT` – [US] The Cardholder Agreement is a legal document that details the terms of a card agreement between either a consumer or a business, and the financial institution that issues the card. The Agreement governs the use of the account. [CA] A legal document that details the terms of a customer’s use of a card and their relationship with the issuing financial institution, Synctera (if applicable), and the Distributor of the Card (the FinTech). The Agreement governs the customer’s use of the Card and the account, including their rights and obligations. * `CARD_DISCLOSURE` – [CA] Part of the Cardholder Agreement, the Disclosure highlights prescribed terms and conditions that apply to the customer's use of the Card. The Disclosure can be incorporated into the Agreement itself, but is often shown separately to ensure clear understanding of the regulated terms. * `E_SIGN` – [US] US law with rules around electronic agreements/documents/disclosures: used to obtain consent from consumers to receive electronic communications (agreements, disclosures, statements, etc) about their accounts. [CA] In order for you to send customers regulatory notices, disclosures, and documents electronically and to collect their consent electronically, customers need to acknowledge an Electronic Consent form. This should happen first so the disclosures that follow are acknowledged with the customer’s consent to do so electronically. * `KYC_DATA_COLLECTION` – [US] Document advising the customer that you will collect their personal information (name, date of birth, tax ID, etc.) and will be validating their information against external data/documentation. * `PAD_AUTHORIZATION` – [CA] You must record a customer's authorization prior to facilitating a pre-authorized EFT debit transaction. This form records their authorization for you to facilitate future EFTs from their account. This can be a sporadic or recurring PAD; if sporadic, you need to confirm the customer's authorization prior to each future transaction. * `PRIVACY_NOTICE` – [US] Document that tells customers what is done with their non-public information, who it is shared with, how is is secured, and how they can opt out of it being shared beyond Synctera. [CA] It is a requirement for you to disclose to customers how you collect, use, disclose, and store their personal information, including how information is shared with third parties like Synctera, what their rights are, and how they can withdraw their consent. You must collect explicit consent from customers to this notice. * `OWNER_CERTIFICATION` – [US] Disclosure to certify that the beneficial owners of the business have been correctly entered. [CA] Applicable to business customers only, this certifies that the beneficial owners of the business have been correctly entered. * `REG_CC` – [US] US regulation that implements the Expedited Funds Availability Act: describes standards for when a financial institution makes funds available in a deposit account. * `REG_DD` – [US] US regulation that implements the Truth in Savings Act, to inform customers about the terms and rules for a deposit account. * `REG_E` – [US] US regulation that implements the Electronic Funds Transfer Act: covers liability for electronic transactions, disputes for fraudulent or unrecognized electronic transactions, and consent for electronic debits from a consumer's account. * `TERMS_AND_CONDITIONS` – [US] A detailed agreement between you and the consumer for the structure, terms, fees, charges, rates of the product or service, and the rules for the relationship between you and the consumer. * `SC_ACCOUNT_AGREEMENT` – [US] A detailed agreement between you and the consumer for the structure and terms of service for smart card accounts. * `SC_SECURITY_AGREEMENT` – [US] A detailed agreement between you and the consumer for the terms of service for smart card security account. * `SC_AUTO_PAYMENT` - [US] A detailed agreement between you and the consumer for the structure and terms of service for smart card auto repayment. * `TILA` – [US] Truth in Lending Act (Regulation Z) disclosures for credit products. Discloses the annual percentage rate (APR), finance charges, total amount financed, payment schedule, and other material credit terms to the consumer before they enter into a credit agreement. * `MLA` – [US] Military Lending Act disclosures required when extending credit to covered borrowers (active-duty service members and their dependents). Discloses the Military Annual Percentage Rate (MAPR), payment obligations, and the consumer's rights under the MLA. * `FCRA` – [US] Fair Credit Reporting Act disclosures required when a consumer report is used in connection with a credit application. Includes the consumer's right to obtain a free copy of their credit report and to dispute inaccurate information. * `SF_PREPAID_CARD_DISCLOSURE` – [US] A short form disclosure is a concise, standardized summary of a card's key fees that must be presented to the consumer before they acquire the account. It highlights the most important costs a consumer needs to know upfront — such as the monthly fee, purchase fee, ATM withdrawal fee, and reload fee — and is displayed on-screen during the enrollment process to allow for quick, at-a-glance review before the consumer completes registration. * `LF_PREPAID_CARD_DISCLOSURE` – [US] A long form disclosure is a comprehensive fee schedule and terms document covering all fees, conditions, limitations, and consumer rights associated with the card. It must also be made available to the consumer before account acquisition and satisfies the full disclosure requirements under Regulation E and the CFPB's prepaid account rule. It is presented on-screen during the enrollment process, giving consumers a complete picture of the product's terms before they are bound by the account agreement. * `DEPOSIT_SWEEP` - Records the customer's agreement to participate in a deposit sweep program, whereby balances exceeding a specified threshold in their deposit account may be automatically transferred to a network of participating institutions for the purpose of maximizing FDIC insurance coverage or yield optimization. The customer's consent to this arrangement is recorded separately from the account agreement at the sponsoring bank's request. enum: - ACH_AUTHORIZATION - CARDHOLDER_AGREEMENT - CARD_DISCLOSURE - DIRECT_BILLING_AUTHORIZATION - E_SIGN - FCRA - KYC_DATA_COLLECTION - MLA - PAD_AUTHORIZATION - PRIVACY_NOTICE - OWNER_CERTIFICATION - REG_CC - REG_DD - REG_E - TERMS_AND_CONDITIONS - TILA - SC_ACCOUNT_AGREEMENT - SC_SECURITY_AGREEMENT - SC_AUTO_PAYMENT - SF_PREPAID_CARD_DISCLOSURE - LF_PREPAID_CARD_DISCLOSURE - DEPOSIT_SWEEP type: string version: description: Version of the disclosure document. example: '1.0' pattern: ^v?[0-9]+\.[0-9]+$ type: string responses: bad_request: content: application/json: schema: $ref: '#/components/schemas/error' description: Bad request unauthorized: content: application/json: schema: $ref: '#/components/schemas/error' description: Unauthorized forbidden: content: application/json: schema: $ref: '#/components/schemas/error' description: Forbidden not_found: content: application/json: schema: $ref: '#/components/schemas/error' description: Resource not found internal_server_error: content: application/json: schema: $ref: '#/components/schemas/error' description: Internal server error securitySchemes: bearerAuth: bearerFormat: api_key scheme: bearer type: http ````