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: /rdc/deposits/{deposit_id}: summary: Remote Check Deposit by Id description: > The Remote Check Deposit represents one deposit made using remote deposit capture associated with an account get: tags: - Remote Check Deposit (beta) summary: Get Remote Check Deposit description: >- Retrieves one deposit made using remote deposit capture associated with an account operationId: getRdcDeposit parameters: - $ref: '#/components/parameters/deposit_id_path' responses: '200': content: application/json: schema: $ref: '#/components/schemas/deposit_get' description: Successful retrieval of a Remote Check Deposit '400': $ref: '#/components/responses/bad_request' '401': $ref: '#/components/responses/unauthorized' '404': $ref: '#/components/responses/not_found' components: parameters: deposit_id_path: description: ID of a deposit for a remote deposit capture in: path name: deposit_id required: true schema: example: b01db9c7-78f2-4a99-8aca-1231d32f9b96 format: uuid type: string schemas: deposit_get: allOf: - $ref: '#/components/schemas/deposit' - required: - id - account_id - check_amount - deposit_currency - front_image_id - back_image_id - status - deposit_amount - date_processed - date_captured deposit: allOf: - $ref: '#/components/schemas/deposit_request' - properties: creation_time: example: '2010-05-06T12:23:34.321Z' format: date-time type: string date_captured: description: Date the deposit was captured, in RFC 3339 format example: '2010-05-06T12:23:34.321Z' format: date-time type: string date_processed: description: Date the deposit was processed, in RFC 3339 format example: '2010-05-06T12:23:34.321Z' format: date-time type: string deposit_amount: description: Amount deposited in ISO 4217 minor currency units example: 12345 type: integer file_loc_identifier: description: >- Identifier of the ICL file this deposit was transmitted in, if any nullable: true type: string id: description: Remote Check Deposit ID example: b01db9c7-78f2-4a99-8aca-1231d32f9b96 format: uuid type: string last_updated_time: example: '2010-05-06T12:23:34.321Z' format: date-time type: string matching_declined_check: description: >- IDs of other deposits, already rejected, that appear to match this check (same amount, MICR, and check number). Advisory only; does not block this deposit. items: format: uuid type: string type: array matching_pending_check: description: >- IDs of other deposits, currently pending, that appear to match this check (same amount, MICR, and check number). Advisory only; does not block this deposit. items: format: uuid type: string type: array matching_submitted_check: description: >- IDs of other deposits, already submitted, that appear to match this check (same amount, MICR, and check number). Advisory only; does not block this deposit. items: format: uuid type: string type: array ocr_account_number: description: >- Account number of the issuer of the check, included if OCR is successful example: '123456789' type: string ocr_check_number: description: >- The unique check number for this check in the checkbook, included if OCR is successful and there is a check number on the check example: '001' type: string ocr_routing_number: description: >- Routing number of the issuing bank, included if OCR is successful example: 26009593 type: string status: $ref: '#/components/schemas/deposit_status' transaction_id: description: The ID of the transaction associated with this deposit example: b01db9c7-78f2-4a99-8aca-1231d32f9b96 format: uuid type: string vendor_info: $ref: '#/components/schemas/vendor_info' type: object description: Deposit using remote deposit capture title: Remote Check Deposit 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 deposit_request: description: User provided request to submit an RDC properties: account_id: description: The ID of the account example: b01db9c7-78f2-4a99-8aca-1231d32f9b96 format: uuid type: string back_image_id: description: ID of the uploaded image of the back of the check example: b01db9c7-78f2-4a99-8aca-1231d32f9b96 format: uuid type: string business_id: $ref: '#/components/schemas/business_id' check_amount: description: Amount on check in ISO 4217 minor currency units example: 12345 minimum: 1 type: integer deposit_currency: description: ISO 4217 currency code for the deposit amount example: USD type: string front_image_id: description: ID of the uploaded image of the front of the check example: b01db9c7-78f2-4a99-8aca-1231d32f9b96 format: uuid type: string metadata: $ref: '#/components/schemas/metadata' person_id: $ref: '#/components/schemas/person_id' tenant: $ref: '#/components/schemas/tenant_id' title: Remote Check Deposit Request type: object deposit_status: description: The status of the deposit enum: - SUBMITTED - PENDING - FAILED - REJECTED - RETURNED - MANUAL_POST_REJECTED type: string vendor_info: description: Vendor information for external account management systems properties: vendor_data: $ref: '#/components/schemas/vendor_data' vendor_type: $ref: '#/components/schemas/vendor_type' required: - vendor_type - vendor_data 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 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 vendor_data: description: Vendor-specific data properties: loanpro: $ref: '#/components/schemas/loanpro_vendor_data' type: object vendor_type: description: The type of vendor managing this account enum: - LOANPRO example: LOANPRO type: string loanpro_vendor_data: allOf: - $ref: '#/components/schemas/base_loanpro_vendor_data' description: > LoanPro-specific vendor data for account * Optional fields will be inherited from the account template if not provided required: - loc_id base_loanpro_vendor_data: properties: cash_advance_bucket_id: description: LoanPro cash advance bucket ID example: 67890 format: int64 type: integer loc_id: description: LoanPro line of credit account ID example: 12345 format: int64 type: integer loc_product_id: description: LoanPro line of credit product ID example: 67890 format: int64 type: integer purchases_bucket_id: description: LoanPro purchases bucket ID example: 12345 format: int64 type: integer tenant_id: description: LoanPro tenant ID example: '1' type: string type: object 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 not_found: content: application/json: schema: $ref: '#/components/schemas/error' description: Resource not found securitySchemes: bearerAuth: bearerFormat: api_key scheme: bearer type: http ````