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: /cash: summary: Cashier description: | The Cashier API allows you to create, retrieve, and update cash transfers. get: tags: - Cash Orders and Deposits (alpha) summary: Get cash transfers description: > Get all cash transfers > 🚧 Alpha > This is an Alpha spec-only endpoint. Feedback from the community is welcome. We may make breaking changes. operationId: getCashTransfers parameters: - $ref: '#/components/parameters/cash_id_query' - $ref: '#/components/parameters/cash_bank_id_query' - $ref: '#/components/parameters/cash_partner_id_query' - $ref: '#/components/parameters/cash_customer_id_query' - $ref: '#/components/parameters/cash_originating_account_id_query' - $ref: '#/components/parameters/cash_destination_account_id_query' - $ref: '#/components/parameters/cash_originating_account_number_query' - $ref: '#/components/parameters/cash_destination_account_number_query' - $ref: '#/components/parameters/cash_originating_account_owner_name_query' - $ref: '#/components/parameters/cash_destination_account_owner_name_query' - $ref: '#/components/parameters/cash_status_query' - $ref: '#/components/parameters/cash_network_status_query' - $ref: '#/components/parameters/cash_subtype_query' - $ref: '#/components/parameters/cash_dc_sign_query' - $ref: '#/components/parameters/cash_effective_date_query' - $ref: '#/components/parameters/cash_from_effective_date_query' - $ref: '#/components/parameters/cash_to_effective_date_query' - $ref: '#/components/parameters/cash_posting_date_query' - $ref: '#/components/parameters/cash_from_posting_date_query' - $ref: '#/components/parameters/cash_to_posting_date_query' - $ref: '#/components/parameters/cash_amount_query' - $ref: '#/components/parameters/cash_min_amount_query' - $ref: '#/components/parameters/cash_max_amount_query' - $ref: '#/components/parameters/cash_currency_query' - $ref: '#/components/parameters/cash_reference_id_query' - $ref: '#/components/parameters/cash_is_same_day_query' responses: '200': content: application/json: schema: $ref: '#/components/schemas/cash_list' description: Retrieve all Cashier transfers '400': $ref: '#/components/responses/bad_request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '500': $ref: '#/components/responses/internal_server_error' components: parameters: cash_id_query: description: Cashier Transfer ID in: query name: id schema: type: string cash_bank_id_query: description: Bank ID of the transfer in: query name: bank_id schema: type: string cash_partner_id_query: description: Partner ID of the transfer in: query name: partner_id schema: type: string cash_customer_id_query: description: Customer ID of the transfer in: query name: customer_id schema: type: string cash_originating_account_id_query: description: Originating account ID in: query name: originating_account_id schema: example: 7d943c51-e4ff-4e57-9558-08cab6b963c7 type: string cash_destination_account_id_query: description: Destination account ID in: query name: destination_account_id schema: example: 7d943c51-e4ff-4e57-9558-08cab6b963c7 type: string cash_originating_account_number_query: description: Originating account number in: query name: originating_account_number schema: example: '123456789' type: string cash_destination_account_number_query: description: Destination account number in: query name: destination_account_number schema: example: '987654321' type: string cash_originating_account_owner_name_query: description: Originating account owner name in: query name: originating_account_owner_name schema: type: string cash_destination_account_owner_name_query: description: Destination account owner name in: query name: destination_account_owner_name schema: example: Jane Joe type: string cash_status_query: description: Status of the transfer in: query name: status schema: type: string cash_network_status_query: description: Network status of the transfer in: query name: network_status schema: type: string cash_subtype_query: description: Subtype of the transfer in: query name: subtype schema: type: string cash_dc_sign_query: description: DC sign of the transfer in: query name: dc_sign schema: type: string cash_effective_date_query: description: Effective date of the transfer in: query name: effective_date schema: type: string cash_from_effective_date_query: description: From effective date of the transfer in: query name: from_effective_date schema: type: string cash_to_effective_date_query: description: To effective date of the transfer in: query name: to_effective_date schema: type: string cash_posting_date_query: description: Posting date of the transfer in: query name: posting_date schema: type: string cash_from_posting_date_query: description: From posting date of the transfer in: query name: from_posting_date schema: type: string cash_to_posting_date_query: description: To posting date of the transfer in: query name: to_posting_date schema: type: string cash_amount_query: description: Amount of the transfer in: query name: amount schema: example: 100 type: string cash_min_amount_query: description: Minimum amount of the transfer in: query name: min_amount schema: example: 100 minimum: 1 type: integer cash_max_amount_query: description: Maximum amount of the transfer in: query name: max_amount schema: example: 100 minimum: 1 type: integer cash_currency_query: description: Currency of the transfer in: query name: currency schema: example: CAD type: string cash_reference_id_query: description: Reference ID of the transfer in: query name: reference_id schema: type: string cash_is_same_day_query: description: Is same day transfer in: query name: is_same_day schema: type: boolean schemas: cash_list: allOf: - properties: transfers: description: Array of transfers. items: $ref: '#/components/schemas/cash_response' type: array required: - transfers type: object - $ref: '#/components/schemas/paginated_response' cash_response: allOf: - $ref: '#/components/schemas/cash_base' - properties: client_bank_account: description: The bank account of the client. example: 123456789 type: string client_name: description: The name of the client. example: Fintech A type: string customer_id: description: > The UUID of the Synctera customer resource that is the originator of the transfer. example: 46fec39e-e776-4571-bf90-d0e1d15172fe type: string destination_account_id: description: > The UUID of the Synctera account that is the destination of the transfer. For a transfer originated by the Synctera platform, this will be an external account resource, while for a transfer originated by the external account, this account will be an account resource. example: fccb4a46-1261-4e91-b622-73b5b946183d type: string destination_account_number: description: The account number of the destination account. example: 1344012344 format: string type: string destination_account_owner_name: description: The account owner name of the destination account. type: string effective_date: description: The effective date of the transaction once it gets posted example: '2022-03-18' format: date type: string failed: description: Whether the transfer failed or not. example: false type: boolean history: items: $ref: '#/components/schemas/action' type: array id: description: ID of the transfer format: uuid type: string is_same_day: description: >- Send the same day (use only is_same_day without specific effective_date). example: true type: boolean network_status: $ref: '#/components/schemas/cash_network_status' original_reference_id: description: The original reference id of the transfer if it's a return. example: 123456788 type: string originating_account_id: description: > The UUID of the Synctera account that is the origination of the transfer. For a transfer originated by the Synctera platform, this will be an account resource, while for a transfer originated by the external account, this will be an external account resource. example: b01db9c7-78f2-4a99-8aca-1231d32f9b96 type: string originating_account_number: description: The account number of the originating account. example: 1961234745 format: string type: string originating_account_owner_name: description: The account owner name of the origination account. type: string posting_date: description: The posting date of the transaction once it gets posted example: '2022-03-18' format: date type: string reference_id: description: The reference id of the transfer. example: 123456789 type: string status: $ref: '#/components/schemas/cash_status' subtype: description: The subtype of the transfer enum: - CASH_ORDER - CASH_ORDER_REVERSAL - DEPOSIT - DEPOSIT_REVERSAL example: CASH_ORDER type: string suspended: description: Whether the transfer is suspended or not. example: false type: boolean tenant_id: $ref: '#/components/schemas/tenant_id' transaction_id: description: The related transaction id of the transfer. example: 45b5246f-ad97-4629-9aac-465b74a05505 format: uuid type: string required: - id - tenant_id - effective_date - is_same_day - status - subtype - reference_id description: Cash transfer title: Cash Transfer Response type: object paginated_response: properties: next_page_token: description: >- If returned, use the next_page_token to query for the next page of results. Not returned if there are no more rows. example: a8937a0d type: string title: Paginated List response 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 cash_base: description: Cash transfer properties: amount: description: Transfer amount in cents example: 10000 format: int64 minimum: 1 type: integer dc_sign: description: Debit or credit sign enum: - DEBIT - CREDIT example: DEBIT type: string source_data: description: Additional information to be added to the transfer type: object required: - amount - dc_sign title: Cash Transfer type: object action: properties: data: type: object message: type: string timestamp: format: date-time required: - message - timestamp - data type: object cash_network_status: description: | The network status of the transfer in the Synctera platform. enum: - PENDING - POSTED - RETURNED - REVERSED example: POSTED type: string cash_status: description: > The status of the transfer in the Synctera platform. This is automatically set upon the creation of a transfer. To cancel a transfer, the current status must be 'INITIATED' or 'PENDING' and the request status set to 'CANCELLED'. To trigger a return, the current status must be 'POSTED' and the returned status will be set to 'RETURNED' if successful. enum: - INITIATED - PENDING - POSTED - CANCELLED - EXPIRED example: POSTED type: string tenant_id: description: | The id of the tenant containing the resource. example: abcdef_ghijkl 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 internal_server_error: content: application/json: schema: $ref: '#/components/schemas/error' description: Internal server error securitySchemes: bearerAuth: bearerFormat: api_key scheme: bearer type: http ````