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: /wires: summary: Wire get: tags: - Wires summary: List outgoing wires description: Get paginated list of wires operationId: listWires parameters: - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/page_token' - $ref: '#/components/parameters/status' - $ref: '#/components/parameters/customer_id' - $ref: '#/components/parameters/originating_account_id' - $ref: '#/components/parameters/receiving_account_id' - $ref: '#/components/parameters/id' - $ref: '#/components/parameters/from_date' - $ref: '#/components/parameters/to_date' responses: '200': content: application/json: schema: $ref: '#/components/schemas/wire_list' description: List of wires '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '500': $ref: '#/components/responses/internal_server_error' components: parameters: limit: in: query name: limit schema: default: 100 description: > Maximum number of objects to return per page. If the limit is greater than 100, then it will be set to 100. example: 100 minimum: 1 type: integer page_token: in: query name: page_token schema: description: >- Optional pagination token to be provided to retrieve subsequent pages, returned from previous get example: a8937a0d type: string status: description: The status of the transaction explode: false in: query name: status schema: example: PENDING,PARTCLEARED items: type: string type: array customer_id: description: The unique identifier for customer in: query name: customer_id schema: example: 7d943c51-e4ff-4e57-9558-08cab6b963c7 format: uuid type: string originating_account_id: description: The unique identifier of the originating account. in: query name: originating_account_id schema: example: b01db9c7-78f2-4a99-8aca-1231d32f9b96 format: uuid type: string receiving_account_id: description: The unique identifier of the receiving account. in: query name: receiving_account_id schema: example: b01db9c7-78f2-4a99-8aca-1231d32f9b96 format: uuid type: string id: description: Unique resource identifier explode: false in: query name: id schema: items: example: 7d943c51-e4ff-4e57-9558-08cab6b963c7 format: uuid type: string type: array style: form from_date: description: Only display transactions with a posting date greater than from_date in: query name: from_date schema: format: date type: string to_date: description: >- Only display transactions with a posting date less than or equal to to_date in: query name: to_date schema: format: date type: string schemas: wire_list: allOf: - properties: wires: description: Array of wires items: $ref: '#/components/schemas/wire' type: array required: - wires type: object - $ref: '#/components/schemas/paginated_response' title: Wire List wire: properties: amount: description: Transfer amount in cents ($100 would be 10000) example: 10000 type: integer bank_message: description: >- Instructions intended for the financial institutions that are processing the wire. type: string batch_id: description: >- The batch ID associated with the wire if it was created via the batch payment API. format: uuid type: string case_id: description: The case id associated with the wire. example: 53 format: integer64 type: integer creation_time: example: '2010-05-06T12:23:34.321Z' format: date-time readOnly: true type: string currency: description: 3-character currency code example: USD type: string customer_id: description: >- The customer UUID representing the person initiating the Wire transfer example: b01db9c7-78f2-4a99-8aca-1231d32f9b96 format: uuid type: string effective_date: description: The effective date of the transaction once it gets posted example: '2022-03-18' format: date type: string fed_input_message_accountability_data: description: >- The Synctera-generated IMAD can be overwritten when the wire is uploaded to the FED. If that happens and we are provided with the new IMAD, it will be populated in this field. example: 10220318BANK0001123456 type: string id: description: wire ID format: uuid readOnly: true type: string input_message_accountability_data: description: >- The input message accountability data consists of a 8 character cycle date (CCYYMMDD) an 8 character source and a 6 character sequence number. example: 10220318BANK0001123456 readOnly: true type: string is_bulk: description: >- Whether or not the wire is a "bulk" wire created via the batch payment API. type: boolean last_updated_time: example: '2010-05-06T12:23:34.321Z' format: date-time readOnly: true type: string network: description: The network used to process the wire example: fedwire type: string originating_account_id: description: Sender account ID example: b01db9c7-78f2-4a99-8aca-1231d32f9b96 format: uuid type: string originating_account_number: description: >- The account number representing the sender account. If the outgoing wire is a return, it refers to the sender of the initial wire not the sender of the return. example: 1961234745 format: string type: string receiving_account_id: description: The external account uuid representing the recipient of the wire. example: b01db9c7-78f2-4a99-8aca-1231d32f9b96 format: uuid type: string receiving_account_number: description: >- The account number representing the recipient account. If the outgoing wire is a return, it refers to the recipient of the initial wire not the destination of the return. example: 1961234745 format: string type: string recipient_message: description: Information from the originator to the beneficiary (recipient). type: string return_data: $ref: '#/components/schemas/return_data' sender_reference_id: description: Sender's id associated with fedwire transfer example: 9F564A6124E65 readOnly: true type: string settlement_date: description: The settlement date of the transaction once it gets posted example: '2022-03-18' format: date type: string status: description: The current status of the transfer enum: - PENDING - COMPLETED - CANCELED - DECLINED example: PENDING readOnly: true type: string status_details: description: Additional details about the status of the transfer enum: - APPROVED - CANCELED - PENDING_DUAL_APPROVAL - DECLINED_DUAL_APPROVAL - SUSPENDED_OFAC_REVIEW example: PENDING_DUAL_APPROVAL type: string transaction_id: description: ID of the resulting transaction resource format: uuid readOnly: true type: string transaction_in_id: description: >- The transaction uuid of the incoming wire that triggered an outgoing return. This is only used if the outgoing wire is a return. example: b01db9c7-78f2-4a99-8aca-1231d32f9b96 format: uuid type: string required: - id - transaction_id - amount - status - effective_date - currency - originating_account_number - receiving_account_number - sender_reference_id - is_bulk - creation_time - last_updated_time title: Wire 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 return_data: description: Filled if the entry is a return. properties: code: description: Return reason code, i.e. why is the entry being returned. example: R01 type: string dishonored_return_code: description: >- Code of the original dishonored return (without "R"). Filled only if this is a contested return. example: '69' type: string dishonored_return_settlement_date: description: >- Settlement date of the original dishonored return. Filled only if this is a contested return. Formatted as an ordinal date, a single day-of-year number between 1-366. example: '256' type: string dishonored_return_trace: description: >- Trace number of the original dishonored return. Filled only if this is a contested return. example: '123456780000069' type: string field_errors: description: >- Required for return reason code R69. Contains the code(s) to indicate the field(s) in which erroneous information in the original return is located. example: '05' type: string original_dfi_no: description: Receiving financial institution of the original entry. example: '364275034' type: string original_trace: description: Trace number of the original entry that is being returned. example: '123456780000069' type: string return_code: description: >- Return reason code of the original return (just the number). Filled only if this is a dishonored return. example: '13' type: string return_settlement_date: description: >- Settlement date of the original return. Filled only if this is a dishonored return. Formatted as an ordinal date, a single day-of-year number between 1-366. example: '256' type: string return_trace: description: >- Trace number of the original return. Filled only if this is a dishonored return. example: '123456780000069' type: string required: - code - original_trace - original_dfi_no type: object 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 ````