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: /external_accounts: summary: External Accounts description: > The External Account resource is used for managing links to accounts that operate outside of the Synctera ecosystem. post: tags: - External Accounts summary: Add an external account description: > Add an external account for a customer. The account will be created in an unverified state. operationId: addExternalAccounts parameters: - $ref: '#/components/parameters/idempotency_key' requestBody: content: application/json: schema: $ref: '#/components/schemas/add_accounts_request' required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/external_account' description: The external account added. '400': $ref: '#/components/responses/bad_request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '409': $ref: '#/components/responses/already_exists' '500': $ref: '#/components/responses/internal_server_error' components: parameters: idempotency_key: description: >- An idempotency key is an arbitrary unique value generated by client to detect subsequent retries of the same request. It is recommended that a UUID or a similar random identifier be used as an idempotency key. A different key must be used for each request, unless it is a retry. in: header name: Idempotency-Key schema: example: 7d943c51-e4ff-4e57-9558-08cab6b963c7 type: string schemas: add_accounts_request: properties: account_identifiers: $ref: '#/components/schemas/add_accounts_request_account_identifiers' account_owner_names: description: The names of the account owners. items: example: Jane Smith minLength: 1 type: string minItems: 1 type: array business_id: description: > The identifier for the business customer associated with this external account. Exactly one of `business_id` or `customer_id` must be specified. example: 7d943c51-e4ff-4e57-9558-08cab6b963c7 format: uuid type: string currency: description: ISO 4217 alphabetic currency code example: USD pattern: ^[A-Z]{3}$ type: string customer_id: description: > The identifier for the personal customer associated with this external account. Exactly one of `customer_id` or `business_id` must be specified. example: 7d943c51-e4ff-4e57-9558-08cab6b963c7 format: uuid type: string customer_type: $ref: '#/components/schemas/ext_account_customer_type' metadata: description: User-supplied metadata type: object nickname: description: A user-meaningful name for the account example: Vacation savings minLength: 1 type: string routing_identifiers: $ref: '#/components/schemas/add_accounts_request_routing_identifiers' tenant: $ref: '#/components/schemas/tenant_id' type: description: The type of the account enum: - CHECKING - SAVINGS - CRYPTO_WALLET - WALLET - OTHER_BANK_ACCOUNT type: string vendor_account_id: description: The ID of the vendor account, will be empty for MANUAL vendor example: blgvvBlXw3cq5GMPwqB6s6q4dLKB9WcVqGDGo minLength: 1 type: string verification: $ref: '#/components/schemas/account_verification' required: - type - customer_type - account_owner_names - routing_identifiers - account_identifiers type: object external_account: properties: account_identifiers: $ref: '#/components/schemas/account_identifiers' account_owner_names: description: > The names of the account owners. Values may be masked, in which case the array will be empty. items: example: Jane Smith type: string type: array business_id: description: > The identifier for the business customer associated with this external account. Exactly one of `business_id` or `customer_id` will be returned. example: 7d943c51-e4ff-4e57-9558-08cab6b963c7 format: uuid type: string creation_time: example: '2010-05-06T12:23:34.321Z' format: date-time type: string currency: description: ISO 4217 alphabetic currency code example: USD pattern: ^[A-Z]{3}$ type: string customer_id: description: > The identifier for the personal customer associated with this external account. Exactly one of `customer_id` or `business_id` will be returned. example: 7d943c51-e4ff-4e57-9558-08cab6b963c7 format: uuid type: string deletion_time: example: '2010-05-06T12:23:34.321Z' format: date-time type: string id: description: External account unique identifier example: 7d943c51-e4ff-4e57-9558-08cab6b963c7 format: uuid readOnly: true type: string last_updated_time: example: '2010-05-06T12:23:34.321Z' format: date-time type: string metadata: description: User-supplied JSON format metadata. type: object name: description: The official name of the account example: Plaid Checking type: string nickname: description: A user-meaningful name for the account example: Vacation savings nullable: true type: string routing_identifiers: $ref: '#/components/schemas/account_routing' status: description: The current state of the account enum: - ACTIVE - CLOSED - DELETED - INACTIVE type: string status_reason: description: The reason for the status for the external account. type: string tenant: $ref: '#/components/schemas/tenant_id' type: description: The type of the account enum: - CHECKING - SAVINGS - CREDIT_CARD - MONEY_MARKET - INVESTMENT_529 - CRYPTO_WALLET - WALLET - OTHER_BANK_ACCOUNT - OTHER type: string vendor_data: $ref: '#/components/schemas/external_account_vendor_data' vendor_info: $ref: '#/components/schemas/vendor_info2' verification: $ref: '#/components/schemas/account_verification' required: - id - account_owner_names - status - type - routing_identifiers - account_identifiers - verification - creation_time - last_updated_time title: External account type: object add_accounts_request_account_identifiers: description: > The identifiers for the account. At least one of `number` or `iban` must be specified. Account number or IBAN can be specified for international accounts. For domestic accounts, only account number is required. properties: iban: description: > The IBAN of the account. On write, Synctera will store the entire IBAN number; on read, we only return the last 4 characters. example: LI4476584648937N59B00 minLength: 1 type: string number: description: > The unique identifier of the account. On write, Synctera will store the entire account number; on read, we only return the last 4 characters. example: '78277121' minLength: 1 type: string title: Identifiers for the account type: object ext_account_customer_type: description: > The type of customer in the external financial institution. _Not_ necessarily the customer type on Synctera's platform: a business customer might link to the owner's personal account at an external financial institution. enum: - PERSONAL - BUSINESS type: string add_accounts_request_routing_identifiers: properties: ach_routing_number: description: | The routing number used for US ACH payments. example: '756392185' minLength: 1 type: string bank_countries: description: The countries that this bank operates the account in items: example: US type: string minItems: 1 type: array bank_name: description: The name of the bank managing the account example: Chase minLength: 1 type: string eft_ca_routing_number: description: > > 🚧 Alpha > This is an Alpha property. Feedback from the community is welcome. We may make breaking changes to this property. The 9 digit routing number used for EFT CA payments, identifying a Canadian bank. The format is 0xxxyyyyy where xxx is the institution number and yyyyy is the transit number. On write, Synctera will store the entire routing number; on read, we only return the last 4 characters. example: '02101140' maxLength: 9 minLength: 9 type: string international_wire_details: $ref: '#/components/schemas/international_wire_details' network: $ref: '#/components/schemas/external_account_network' wire_routing_number: description: | The routing number used for US domestic wire payments. example: '915075033' minLength: 1 type: string required: - bank_name - bank_countries title: Identifiers for the bank type: object tenant_id: description: | The id of the tenant containing the resource. example: abcdef_ghijkl type: string account_verification: description: > Information about the account verification process. If the account has not been verified, this will be null. discriminator: mapping: FINICITY: $ref: '#/components/schemas/finicity_account_verification' MANUAL: $ref: '#/components/schemas/manual_account_verification' PLAID: $ref: '#/components/schemas/plaid_account_verification' propertyName: vendor nullable: true oneOf: - $ref: '#/components/schemas/plaid_account_verification' - $ref: '#/components/schemas/manual_account_verification' - $ref: '#/components/schemas/finicity_account_verification' title: Information about the account verification process type: object account_identifiers: properties: iban: description: > The IBAN of the account. Value may be masked, in which case only the last four digits are returned. example: LI4476584648937N59B00 type: string number: description: > The unique identifier of the account. Value may be masked, in which case only the last four digits are returned. example: '78277121' type: string required: - number title: Identifiers for the account type: object account_routing: properties: ach_routing_number: description: > The routing number used for US ACH payments. Only appears if `bank_countries` contains `US`. Value may be masked, in which case only the last four digits are returned. example: '756392185' type: string bank_address: $ref: '#/components/schemas/address' bank_countries: description: The countries that this bank operates the account in items: example: US type: string type: array bank_name: description: The name of the bank managing the account example: Chase type: string correspondent_bank_details: description: | The details of the correspondent banks for the account. items: $ref: '#/components/schemas/correspondent_bank_details' nullable: true type: array eft_ca_routing_number: description: > > 🚧 Alpha > This is an Alpha property. Feedback from the community is welcome. We may make breaking changes to this property. The 9 digit routing number used for EFT CA payments, identifying a Canadian bank. The format is 0xxxyyyyy where xxx is the institution number and yyyyy is the transit number. On write, Synctera will store the entire routing number; on read, we only return the last 4 characters. Value may be masked, in which case only the last four digits are returned. example: '02101140' type: string eft_routing_number: deprecated: true description: > The routing number used for EFT payments, identifying a Canadian bank, consisting of the institution number and the branch number. Only appears if `bank_countries` contains `CA`. Value may be masked, in which case only the last four digits are returned. This attribute is deprecated and will be removed in a future API version. Use eft_ca_routing_number instead. example: '02101140' type: string network: $ref: '#/components/schemas/external_account_network' swift_code: description: > The SWIFT code for the bank. Value may be masked, in which case only the last four characters are returned. example: CHASUS3AXXX type: string wire_routing_number: description: > The routing number used for domestic wire payments. Only appears if `bank_countries` contains `US`. Value may be masked, in which case only the last four digits are returned. example: '756392185' type: string required: - bank_name - bank_countries title: Routing information for the account type: object external_account_vendor_data: properties: account_number_mask: description: > The last alphanumeric characters of an account's official account number. Note that the mask may be non-unique between accounts, and it may also not match the mask that the bank displays to the user. type: string institution_id: description: The ID of the institution external account belongs type: string type: object vendor_info2: description: > The information provided to Synctera from the vendor. Interpretation of this object is up to the client. discriminator: mapping: application/json: $ref: '#/components/schemas/vendor_json' text/xml: $ref: '#/components/schemas/vendor_xml' propertyName: content_type oneOf: - $ref: '#/components/schemas/vendor_json' - $ref: '#/components/schemas/vendor_xml' title: Vendor Info 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 international_wire_details: properties: bank_address: $ref: '#/components/schemas/address' correspondent_banks_details: description: | Correspondent banks details used for international payments. items: $ref: '#/components/schemas/correspondent_bank_details' type: array swift_code: description: > The SWIFT code (also known as BIC code) used for international payments. example: CHASUS3AXXX pattern: ^[A-Z]{6}[A-Z0-9]{2}([A-Z0-9]{3})?$ type: string required: - swift_code - bank_address title: International bank details type: object external_account_network: description: >- The infrastructure or network governing the transfer of assets for your account. enum: - ALGORAND - AVALANCHE - BITCOIN - CARDANO - CIRCLE - EOS - ETHEREUM - POLKADOT - SOLANA - TRON - OTHER type: string finicity_account_verification: allOf: - $ref: '#/components/schemas/base_account_verification' title: Information specific to Finicity verification manual_account_verification: allOf: - $ref: '#/components/schemas/base_account_verification' title: Information specific to Manual verification plaid_account_verification: allOf: - $ref: '#/components/schemas/base_account_verification' title: Information specific to Plaid verification 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 correspondent_bank_details: properties: bank_address: $ref: '#/components/schemas/address' bank_name: description: | The name of the correspondent bank. example: Bank of Greece minLength: 1 type: string swift_code: description: > The SWIFT code (also known as BIC code) used for international payments. example: BNGRGRAAXXX pattern: ^[A-Z]{6}[A-Z0-9]{2}([A-Z0-9]{3})?$ type: string required: - swift_code - bank_address - bank_name title: Correspondent bank details type: object vendor_json: properties: content_type: description: Describes the content-type encoding received from the vendor enum: - application/json type: string json: description: Data representation in JSON type: object vendor: example: SOCURE type: string required: - vendor - content_type - json vendor_xml: properties: content_type: description: Describes the content-type encoding received from the vendor enum: - text/xml type: string vendor: example: IDOLOGY type: string xml: description: Data representaion in XML type: string required: - vendor - content_type - xml base_account_verification: properties: creation_time: description: The time at which verification was first completed. example: '2010-05-06T12:23:34.321Z' format: date-time type: string last_updated_time: description: The time at which verification was last updated. example: '2010-05-06T12:23:34.321Z' format: date-time type: string status: description: The status of verification enum: - VERIFIED - UNVERIFIED type: string vendor: description: The vendor used for verifying the account enum: - PLAID - MANUAL - FINICITY type: string required: - status - vendor title: Information about account verification type: object id: description: The unique identifier for this resource. example: 7d943c51-e4ff-4e57-9558-08cab6b963c7 format: uuid readOnly: true 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 already_exists: content: application/json: schema: $ref: '#/components/schemas/error' description: Resource already exists internal_server_error: content: application/json: schema: $ref: '#/components/schemas/error' description: Internal server error securitySchemes: bearerAuth: bearerFormat: api_key scheme: bearer type: http ````