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/incoming/{wire_id}: patch: tags: - Wires summary: Update an incoming wire by id description: Update an incoming wire by id operationId: patchIncomingWire parameters: - $ref: '#/components/parameters/wire_id' requestBody: content: application/json: schema: $ref: '#/components/schemas/incoming_wire_patch' description: Patch incoming wire request required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/incoming_wire' description: wire '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: wire_id: description: The unique identifier of a wire transfer. in: path name: wire_id required: true schema: example: b01db9c7-78f2-4a99-8aca-1231d32f9b96 format: uuid type: string schemas: incoming_wire_patch: description: Patch object for incoming wire properties: return_data: $ref: '#/components/schemas/return_data' title: Incoming Wire Patch type: object incoming_wire: properties: amount: description: Transfer amount in cents ($100 would be 10000) example: 10000 type: integer bank_message: description: Information from the sending bank to the receiving bank. type: string 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 decline_reason: description: Description of any errors or problems encountered during processing. type: string effective_date: description: The effective date of the transaction example: '2022-03-18' format: date type: string end_to_end_identification: description: >- A mandatory reference assigned by the customer originating the payment, i.e., Debtor or Ultimate Debtor that must be transported unchanged throughout the payment chain and delivered to the end-customer, i.e., Creditor or Ultimate Creditor to facilitate the customer’s reconciliation. type: string extracted_account_number: description: >- Account number recovered from the unstructured recipient message when the structured beneficiary account number was missing or unusable. When the value matches a known account exactly, the wire is forwarded to the standard posting flow; otherwise it falls to suspense and ops can review this candidate. example: '1961234745' readOnly: true type: string id: description: wire ID format: uuid readOnly: true type: string input_message_accountability_data: description: >- The IMAD of the incoming wire. The field is called Message Identification in the ISO format. example: 10220318BANK0001123456 readOnly: true type: string instruction_identification: description: >- An optional reference that the Fedwire Funds participant sending the message may include in a customer credit transfers sent across the Fedwire Funds Service and will be delivered unchanged to the Fedwire Funds participant receiving the message. type: string is_return: description: Indicates if the wire is a return of an outgoing wire type: boolean network: description: The network used to process the wire example: fedwire type: string originating_account_number: description: The account number of the sender, as provided in the wire file. example: 1961234745 format: string type: string receiver: $ref: '#/components/schemas/party' receiving_account_id: description: >- The internal Synctera 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 of the recipient, as provided in the wire file. 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' return_reason: description: The reason we are returning this wire. type: string sender: $ref: '#/components/schemas/party' 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 example: '2022-03-18' format: date type: string status: description: The current status of the transfer enum: - READY - BLOCKED - POSTED - RETURNED example: READY readOnly: true type: string tenant: $ref: '#/components/schemas/tenant_id' transaction_id: description: ID of the resulting transaction resource format: uuid readOnly: true type: string transaction_identification: description: >- An optional reference that the first financial institution in the end-to-end payment chain may assign to the customer credit transfer and that should remain unchanged throughout the end-to-end funds-transfer chain of financial institutions. type: string type_subtype: description: The fedwire label associated with the subtype code enum: - BASIC_FUNDS_TRANSFER - SAME_DAY_TRANSFER_REVERSAL - PRIOR_DAY_TRANSFER_REVERSAL - RETURN example: BASIC_FUNDS_TRANSFER type: string uetr: description: >- Unique End-To-End Reference (UETR) is a mandatory reference in line with the Universally Unique Identifier (UUID) version 4 standard. The UETR is used to facilitate end-to-end payments tracking. format: uuid type: string required: - id - tenant - sender - receiver - amount - status - sender_reference_id - creation_time - is_return - receiving_account_number title: Incoming Wire 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 party: description: Information about a party in a wire transfer properties: account_number: description: account number of the person example: 192178512 readOnly: true type: string address: $ref: '#/components/schemas/address' address_lines: $ref: '#/components/schemas/address_lines' alternate_identifier: description: alternate identifier of the party, used in place of account number example: 123456789 readOnly: true type: string bank_name: description: name of the bank this party is a member of example: Synctera Bank readOnly: true type: string identifier_type: description: type of value used to identify the party example: Demand Deposit Account Number readOnly: true type: string name: description: name of the person example: John Smith readOnly: true type: string routing_number: description: routing number of the bank this person is a member of example: 272479663 readOnly: true type: string title: Person type: object tenant_id: description: | The id of the tenant containing the resource. example: abcdef_ghijkl type: string 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 address: properties: address_line_1: description: Street address line 1 example: 100 Main St. type: string address_line_2: description: Street address line 2 example: Suite 99 type: string address_type: description: | Specifies the address type. enum: - BILLING - LEGAL - SHIPPING - OPERATING - OTHER example: SHIPPING readOnly: true type: string city: description: City example: New York type: string country_code: description: ISO-3166-1 Alpha-2 country code example: US pattern: ^[A-Z]{2}$ type: string id: $ref: '#/components/schemas/id' is_registered_agent: description: >- Indicates whether an address is a registered agent. Omitted if the address is not a registered agent. example: true type: boolean nickname: description: > A nickname for the address. This is used to identify the address in the UI. example: Home type: string postal_code: description: > Postal code. For US, formats of 12345 or 12345-1234 are accepted. For CA, formats of A1A 1A1 or A1A1A1 (regardless of case) are accepted, and will be converted to A1A 1A1 format. example: '28620' type: string state: description: > State, region, province, or prefecture. This is the ISO-3166-2 subdivision code, excluding the country prefix. For example, TX for Texas USA or TAM for Tamaulipas Mexico. Its length varies by country, e.g. 2 characters for US, 3 for MX. example: NY type: string required: - address_line_1 - country_code type: object address_lines: properties: address_line_1: description: address line 1 from wire file readOnly: true type: string address_line_2: description: address line 2 from wire file readOnly: true type: string address_line_3: description: address line 3 from wire file readOnly: true type: string title: Address Lines type: object id: description: The unique identifier for this resource. example: 7d943c51-e4ff-4e57-9558-08cab6b963c7 format: uuid readOnly: true 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 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 ````