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: /statements/{statement_id}/transactions: summary: Statements get: tags: - Statements summary: Get a statement's transactions description: | Gets the list of transactions for a statement's period. operationId: getStatementTransactions parameters: - $ref: '#/components/parameters/statement_id' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/page_token' responses: '200': content: application/json: schema: $ref: '#/components/schemas/transaction_list' description: List of transactions for a given statement. '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '500': $ref: '#/components/responses/internal_server_error' components: parameters: statement_id: description: The unique identifier of a statement in: path name: statement_id required: true schema: example: 7d943c51-e4ff-4e57-9558-08cab6b963c7 format: uuid type: string 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 schemas: transaction_list: allOf: - properties: transactions: description: Array of statement transactions items: $ref: '#/components/schemas/transaction' type: array required: - transactions type: object - $ref: '#/components/schemas/paginated_response' title: Transaction List transaction: properties: account_id: description: >- The account uuid associated with the transaction. `account_id` and `internal_account_id` are mutually exclusive example: 7d943c51-e4ff-4e57-9558-08cab6b963c7 type: string amount: description: >- The total amount of the transaction including both pending and already posted amounts. The value is represented as the smallest denomination of the applicable currency. format: int64 type: integer creation_time: description: The exact time the transaction was recorded in the ledger format: date-time type: string currency: description: ISO 4217 alphabetic currency code of the transfer amount type: string customer_id: description: | The uuid of the customer that initiated the transaction (if any) type: string dc_sign: description: >- The `dc_sign` represents the direction money was moved. A value of `DEBIT` is money moving out of an account, a value of `CREDIT` is money moving into an account enum: - DEBIT - CREDIT type: string decline: $ref: '#/components/schemas/decline_info' description: description: >- A human-friendly description of the transaction, provided by the integrator type: string effective_date: description: >- The effective date of the transaction. This usually aligns with network settlement date, which differs between transaction types. The effective date is also used to determine effective daily balances for the purposes of interest calculation. format: date type: string enhanced_transaction: $ref: '#/components/schemas/enhanced_transaction_data' force_post: description: >- Determines whether or not a transaction or auth was "forced" or not. A forced transaction skips any account balance checks type: boolean fraud_risk: $ref: '#/components/schemas/fraud_risk_data' group_id: description: >- The group id of the transaction. Every transaction in the ledger is one entry in a double-entry system and the primary and offset transactions share the same `group_id` type: string hold_expiration_time: description: >- The date and time any pending amount is expected to be released back to the account. format: date-time type: string id: description: The unique identifier of the transaction format: uuid type: string internal_account_id: description: >- The internal account uuid associated with the transaction. `account_id` and `internal_account_id` are mutually exclusive example: 7d943c51-e4ff-4e57-9558-08cab6b963c7 type: string last_updated_time: description: The date and time the transaction was last modified format: date-time type: string metadata: description: >- an unstructured json blob representing additional transaction information supplied by the integrator. nullable: true type: object partial_hold: description: >- Determines whether or not the funds on hold were the result of a partial auth or not. If `true` the `pending_amount` of the transaction will be less than the requested amount. This is primarily used for certain types of card transactions. type: boolean pending_amount: description: The amount amount of the transaction currently authorized or on hold format: int64 type: integer posted_amount: description: >- The amount of the transaction that has been fully posted to the account format: int64 type: integer posted_date: description: >- The date the transaction was posted (based on the bank calendar and end-of-day). For transaction with multiple postings, this is the date of the earliest posting. This will be omitted for transactions with a `posted_amount` of `0`. format: date type: string reference_id: description: >- An external ID provided by the payment network to represent this transaction. This is not guaranteed to be globally unique. This will always be omitted for internal transfers. type: string status: $ref: '#/components/schemas/transaction_statuses' subtype: description: >- The subtype of the transaction. For the full list of available values, see the spec for `GET /v1/transactions`. type: string system_description: description: >- A human-friendly description of the transaction, provided by the Synctera platform type: string transaction_time: description: >- The time the transaction occurred. In most cases this will be roughly identical to creation_time, but it can differ in some situations if the payment doesn't appear in the ledger in real-time. format: date-time type: string type: description: >- The type of the transaction. For the full list of available values, see the spec for `GET /v1/transactions`. type: string required: - id - amount - pending_amount - posted_amount - currency - dc_sign - type - subtype - status - creation_time - last_updated_time - effective_date - transaction_time - group_id - force_post - partial_hold 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 decline_info: description: >- The decline object provides information explaining why a declined transaction was declined. properties: decline_details: description: Additional detail about the decline. type: string reason: description: The reason the transaction was declined enum: - ACH_RETURN - BALANCE_VIOLATION - DISABLED_PAYMENT_TYPE - DUPLICATE_TRANSACTION - GATEWAY_DECLINED - GATEWAY_ERROR - INSUFFICIENT_FUNDS - NETWORK_DECLINED - OTHER - SUSPECTED_FRAUD - TRANSACTION_NOT_PERMITTED type: string required: - reason type: object enhanced_transaction_data: description: Enriched transaction metadata properties: category: type: string enhanced_description: type: string enhanced_raw: items: $ref: '#/components/schemas/enhanced_raw_details' type: array type: object fraud_risk_data: description: Transaction fraud risk evaluation result properties: decision: description: The overall decision, based on the vendor response enum: - ACCEPT - DECLINE type: string reasons: description: >- Set of machine-readable descriptions of why the transaction was accepted or declined items: enum: - SUSPECTED_FRAUD - TRANSACTION_NOT_PERMITTED - TRANSACTION_ACCEPTED type: string type: array vendor: description: The external vendor used for risk evaluation enum: - NONE - FEEDZAI - HAWKAI type: string vendor_reasons: description: List of reasons supplied by the provider items: type: string type: array required: - decision - vendor type: object transaction_statuses: description: The status of the transaction enum: - PENDING - DECLINED - COMPLETE type: string enhanced_raw_details: properties: amount: description: The monetary amount of the transaction type: number categorized_by: description: The method used to detrmine the category type: integer category: description: The category of the transaction type: string category_guid: description: The unique identifier for the category type: string described_by: description: The method used to describe the transaction type: integer description: description: A human-readable version of `original_description` type: string extended_transaction_type: description: The transaction type assigned by the partner type: string id: description: The unique partner-defined identifier for the transaction type: integer is_bill_pay: description: Whether the transaction represents a bill payment type: boolean is_direct_deposit: description: Whether or not the transaction represents a direct deposit type: boolean is_expense: description: Whether or not the transaction represents an expense type: boolean is_fee: description: Whether or not the transaction represents a fee type: boolean is_income: description: Whether or not the transaction represents income type: boolean is_international: description: Whether or not the transaction is international type: boolean is_overdraft_fee: description: Whether or not the transaction is an overdraft fee type: boolean is_payroll_advance: description: Whether or not the transaction is a payroll advance type: boolean is_subscription: description: Whether or not the transaction is a subscription type: boolean memo: description: Additional descriptiive information about the transaction type: string merchant_category_code: description: The ISO 18245 category code for the transaction type: integer merchant_guid: description: The unique identifier for the merchant type: string merchant_location_guid: description: The unique identifier for the merchant location type: string original_description: description: The original description for the transaction type: string type: description: >- The type of the transsaction. This will be either `CREDIT` or `DEBIT` type: string 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 ````