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: /rewards: summary: Rewards post: tags: - Rewards summary: Create a reward description: | Create a reward operationId: createReward parameters: - $ref: '#/components/parameters/idempotency_key' requestBody: content: application/json: schema: $ref: '#/components/schemas/reward_post' description: Reward to create required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/reward_response' description: Created reward '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: reward_post: allOf: - $ref: '#/components/schemas/reward_base' - {} required: - account_id - template_id title: Reward creation object type: object reward_response: allOf: - $ref: '#/components/schemas/reward_base' - properties: creation_time: description: The timestamp representing when the reward was created example: '2010-05-06T12:23:34.321Z' format: date-time readOnly: true type: string currency: description: >- currency of the reward, as a three character ISO 4217 alphabetic currency code. example: USD type: string derived_from_uuid: description: >- The ID of the transaction that triggered this automated reward, if applicable. example: 55943c51-e4ff-4e57-9558-08cab6b96400 format: uuid type: string description: description: The description of the reward template. example: Referral Reward type: string id: description: The ID of the reward. example: 44943c51-e4ff-4e57-9558-08cab6b96321 format: uuid type: string internal_account_id: description: >- The ID of internal_account that is the source of the reward transfer. example: 42943c51-e4ff-4e57-9558-08cab6b963c8 format: uuid type: string last_updated_time: description: The timestamp representing when the reward was last updated example: '2010-05-06T12:23:34.321Z' format: date-time readOnly: true type: string reward_category: $ref: '#/components/schemas/reward_category' reward_config_id: description: >- The ID of the reward config that generated this automated reward, if applicable. example: 77943c51-e4ff-4e57-9558-08cab6b96600 format: uuid type: string reward_product_id: description: >- The ID of the reward product that generated this automated reward, if applicable. example: 66943c51-e4ff-4e57-9558-08cab6b96500 format: uuid type: string subtype: $ref: '#/components/schemas/reward_subtype' tenant: $ref: '#/components/schemas/tenant_id' transaction_id: description: The ID the resulting transaction resource. example: 11943c51-e4ff-4e57-9558-08cab6b96333 format: uuid type: string required: - account_id - amount - creation_time - description - template_id - id - last_updated_time - subtype - tenant - transaction_id - currency - internal_account_id title: Reward response object type: object reward_base: properties: account_id: description: The ID of the business or customer account being charged the reward. example: 12943c51-e4ff-4e57-9558-08cab6b96364 format: uuid type: string amount: description: > The amount of the reward in ISO 4217 minor currency units, e.g. cents. The internal account referenced by the reward template will be debited this amount. Defaults to the value in the reward template. example: 1000 type: integer metadata: $ref: '#/components/schemas/metadata' note: description: An optional note for this instance of the reward. example: Reduced account reward based on phone call with customer type: string template_id: description: > The ID of the reward template to use to create the reward. Values from the reward template will be used as defaults for the reward. Note that the reward template may have been updated since the reward was created and that such subsequent updates to the reward template do not affect existing rewards. example: 64943c51-e4ff-4e57-9558-08cab6b96352 format: uuid type: string title: Common properties for reward schemas type: object reward_category: description: > The category of event that triggers this reward. Trigger-based categories fire when a matching card transaction is posted. enum: - cashback:card:mcc type: string reward_subtype: description: | A short string representing the sub-type of the reward. This will be used as the subtype of the resulting transaction. enum: - ACCOUNT_OPENING_BONUS - ACCOUNT_OPENING_BONUS_REVERSAL - CASHBACK - CASHBACK_REVERSAL - INTEREST_RATE_BONUS - INTEREST_RATE_BONUS_REVERSAL - LOAN_INTEREST_RATE_REDUCTION - LOAN_INTEREST_RATE_REDUCTION_REVERSAL - MANUAL_ADJUSTMENT - MANUAL_ADJUSTMENT_REVERSAL - MILES - MILES_REVERSAL - MISCELLANEOUS - MISCELLANEOUS_REVERSAL - POINTS - POINTS_REVERSAL - REFERRAL_BONUS - REFERRAL_BONUS_REVERSAL type: string 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 metadata: description: > Optional field to store additional information about the resource. Intended to be used by the integrator to store non-sensitive data. type: object 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 ````