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: /transactions/pending: summary: List pending transactions description: > Pending transactions represent a "hold" of a paricular amount on an account balance. get: tags: - Transactions summary: List pending transactions description: | Get paginated list of pending transactions matching the provided filters operationId: listPendingTransactions parameters: - $ref: '#/components/parameters/uuid_query' - $ref: '#/components/parameters/uuid_nin_query' - $ref: '#/components/parameters/idempotency_key_query' - $ref: '#/components/parameters/account_no2' - $ref: '#/components/parameters/reference_id' - $ref: '#/components/parameters/account_id1' - $ref: '#/components/parameters/card_id' - $ref: '#/components/parameters/digital_wallet_token_id_query' - $ref: '#/components/parameters/barcode_number_query' - $ref: '#/components/parameters/from_date' - $ref: '#/components/parameters/to_date' - $ref: '#/components/parameters/status' - $ref: '#/components/parameters/transaction_id' - $ref: '#/components/parameters/transaction_type' - $ref: '#/components/parameters/transaction_subtype' - $ref: '#/components/parameters/cashback' - $ref: '#/components/parameters/include_child_transactions' - $ref: '#/components/parameters/exclude_jit_transactions' - $ref: '#/components/parameters/amount' - $ref: '#/components/parameters/total_amount' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/page_token' responses: '200': content: application/json: schema: $ref: '#/components/schemas/pending_transactions' description: Paginated list of pending transactions '400': $ref: '#/components/responses/bad_request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '422': $ref: '#/components/responses/unprocessable_entity' '500': $ref: '#/components/responses/internal_server_error' components: parameters: uuid_query: description: > Unique identifier for the resource. Multiple IDs can be provided as a comma-separated list. explode: false in: query name: id schema: example: >- 64438afd-fa20-4010-a573-2bbdca77cdb6,84ef251c-ab8f-47a5-bbfd-a16648f95157 items: format: uuid type: string type: array style: form uuid_nin_query: description: >- Transaction UUID(s) to exclude from the query. Multiple UUIDs can be provided as a comma-separated list. explode: false in: query name: uuid_nin schema: example: >- ba313a66-cbb6-4bc3-aa37-6548448ecb32,cadb3dd1-feb0-42c3-b545-afbbfa99eb7f items: format: uuid type: string type: array idempotency_key_query: description: >- Transaction Idempotency Key(s). Multiple keys can be provided as a comma-separated list. explode: false in: query name: idempotency_key schema: example: >- ba313a66-cbb6-4bc3-aa37-6548448ecb32,cadb3dd1-feb0-42c3-b545-afbbfa99eb7f items: type: string type: array account_no2: description: Account number in: query name: account_no schema: type: string reference_id: description: Reference ID in: query name: reference_id schema: type: string account_id1: description: Account ID explode: false in: query name: account_id schema: items: format: uuid type: string type: array card_id: description: Card ID in: query name: card_id schema: example: 6dc0397d-1aba-4be9-9582-895a7a887d49 format: uuid type: string digital_wallet_token_id_query: description: >- Digital Wallet token ID(s). Multiple IDs can be provided as a comma-separated list. explode: false in: query name: digital_wallet_token_id schema: example: >- ba313a66-cbb6-4bc3-aa37-6548448ecb32,cadb3dd1-feb0-42c3-b545-afbbfa99eb7f items: format: uuid type: string type: array barcode_number_query: description: >- Barcode number(s). Multiple barcode numbers can be provided as a comma-separated list. explode: false in: query name: barcode_number schema: example: 123456789012345678901234567890,098765432109876543210987654321 items: type: string type: array 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 status: description: The status of the transaction explode: false in: query name: status schema: example: PENDING,PARTCLEARED items: type: string type: array transaction_id: description: Only display holds linked to the provided transaction id in: query name: transaction_id schema: example: 7d943c51-e4ff-4e57-9558-08cab6b963c7 format: uuid type: string transaction_type: description: >- Only display transactions matching the given type. The type typically represents the payment rail used. Valid values are `ach`, `card`, `cash`, `check`, `dispute`, `eft_ca`, `external_card`, `fednow`, `fee`, `internal_transfer`, `reward`, `synctera_pay`, and `wire`. in: query name: type schema: example: card type: string transaction_subtype: description: Only display transactions matching the given subtype in: query name: subtype schema: type: string cashback: description: >- If true, only transactions with cashback will be returned. If false, only transactions without cashback will be returned. If not provided, all transactions will be returned. in: query name: cashback schema: type: boolean include_child_transactions: description: >- Include transactions from sub-accounts when listing transactions for a given account in: query name: include_child_transactions schema: type: boolean exclude_jit_transactions: description: Hide "JIT funding" transactions from results in: query name: exclude_jit_transactions schema: type: boolean amount: description: >- Only return transactions equal to the given amount (in minor currency units, e.g., cents). in: query name: amount schema: example: 1000 format: int64 minimum: 0 type: integer total_amount: description: >- Only return transactions equal to the given total amount (in minor currency units, e.g., cents). This may differ from amount for holds with increases/decreases. in: query name: total_amount schema: example: 1200 format: int64 minimum: 0 type: integer 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: pending_transactions: 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. nullable: true type: string result: description: List of pending transactions items: $ref: '#/components/schemas/pending_transaction' type: array required: - result - next_page_token title: Pending Transactions Response type: object pending_transaction: properties: account_id: description: The account id associated with the hold example: 7d943c51-e4ff-4e57-9558-08cab6b963c7 type: string account_no: description: The account number associated with the hold type: string created: description: The creation date of the hold format: date-time type: string data: $ref: '#/components/schemas/pending_transaction_data' enhanced_transaction: $ref: '#/components/schemas/enhanced_transaction_response' id: format: int64 type: integer idemkey: description: The idempotency key used when initially creating this hold. type: string offset_account_id: description: The offset account id associated with the hold example: 7d943c51-e4ff-4e57-9558-08cab6b963c7 type: string offset_account_no: description: The offset account number associated with the hold type: string reference_id: description: >- An external ID provided by the payment network to represent this transaction. nullable: true type: string tenant: $ref: '#/components/schemas/tenant_id' updated: description: The date the hold was last update format: date-time type: string uuid: description: The unique identifier of the hold transaction. format: uuid type: string required: - id - uuid - tenant - idemkey - account_no - account_id - created - updated - reference_id - data title: A pending transaction 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 pending_transaction_data: properties: amount: description: The amount of the hold. format: int64 minimum: 0 type: integer auto_post_at: description: The account "available balance" at the time this hold was created format: date-time type: string avail_balance: description: >- The account "available balance" at the time this hold was created (to be deprecated) format: int64 type: integer available_balance: description: The account "available balance" at the time this hold was created format: int64 type: integer balance: description: The account balance at the time this hold was created format: int64 type: integer currency: description: ISO 4217 alphabetic currency code of the transfer amount type: string dc_sign: $ref: '#/components/schemas/dc_sign' effective_date: description: The effective date of the transaction once it gets posted format: date-time type: string expires_at: description: The date that at which this hold is no longer valid. format: date-time type: string external_data: $ref: '#/components/schemas/external_data' force_post: description: Whether or not the hold was forced (spending controls ignored) type: boolean history: description: >- An array representing any previous states of the hold, if it has been modified (For example, increasing or decreasing the hold amount). items: $ref: '#/components/schemas/pending_transaction_history1' type: array idemkey: description: The idempotency key used when initially creating this hold. type: string indefinite: description: >- If true, the hold will not expire automatically. The hold remains active until it is explicitly released or posted. type: boolean memo: description: A short note to the recipient type: string network: description: The network this transaction is associated with type: string operation: enum: - hold_new - hold_increase - hold_decrease - hold_replace - hold_decline - hold_cancel - hold_post - hold_expire type: string reason: description: >- If a hold has been declined or modified, this will include the reason. type: string req_amount: description: The requested amount, in the case of hold modifications. format: int64 minimum: 0 type: integer risk_info: $ref: '#/components/schemas/risk_info' status: description: The status of the hold. enum: - PENDING - REPLACED - DECLINED - RELEASED - PARTCLEARED - EXPIRED - CLEARED - INTERNAL_ERROR type: string subtype: description: >- The specific transaction type. For example, for `ach`, this may be "outgoing_debit". type: string total_amount: description: >- The total amount of the hold. This may be different than `amount` in the case where a hold increase or decrease was requested. format: int64 minimum: 0 type: integer transaction_id: description: >- The uuid of the transaction that this pending transaction originated from, if any. This is primary used when a transaction "posts", but a subset of the amount reserved until a future settlement date. format: uuid nullable: true type: string transaction_time: description: The time that the transaction was created format: date-time type: string type: description: The general type of transaction. For example, "card" or "ach". type: string user_data: $ref: '#/components/schemas/user_data' was_partial: description: Does this hold represent a partial debit (or credit)? type: boolean required: - memo - type - subtype - operation - idemkey - expires_at - effective_date - total_amount - amount - req_amount - dc_sign - currency - network - was_partial - force_post - status - reason - balance - avail_balance - available_balance - auto_post_at - history - transaction_time title: Pending transaction data type: object enhanced_transaction_response: description: >- Financial data that has been refined by cleansing, categorizing and adding metadata. For example, inconsistencies in raw transaction data that were introduced via data aggregation are removed, transactions are categorized into groups such as "groceries" or utilities", and metadata (such as merchant names or location and timing details) are added for clarity. type: object tenant_id: description: | The id of the tenant containing the resource. example: abcdef_ghijkl type: string dc_sign: description: The `dc_sign` represents the direction money was moved. enum: - debit - credit type: string external_data: description: >- an unstructured json blob representing additional transaction information supplied by the integrator. nullable: true type: object pending_transaction_history1: properties: account_id: description: The account id associated with the hold example: 7d943c51-e4ff-4e57-9558-08cab6b963c7 type: string account_no: description: The account number associated with the hold type: string created: description: The creation date of the hold format: date-time type: string data: $ref: '#/components/schemas/pending_transaction_history_data1' id: format: int64 type: integer idemkey: description: The idempotency key used when initially creating this transaction. type: string offset_account_id: description: The offset account id associated with the hold example: 7d943c51-e4ff-4e57-9558-08cab6b963c7 type: string offset_account_no: description: The offset account number associated with the hold type: string reference_id: description: >- An external ID provided by the payment network to represent this transaction. nullable: true type: string tenant: $ref: '#/components/schemas/tenant_id' updated: description: The date the hold was last update format: date-time type: string uuid: description: The unique identifier of the hold transaction. format: uuid type: string required: - id - uuid - tenant - idemkey - account_no - account_id - created - updated - reference_id title: A pending transaction history type: object risk_info: description: >- Information received by the transaction risk/fraud service related to this transaction nullable: true type: object user_data: description: >- An unstructured JSON blob representing additional transaction information specific to each payment rail. nullable: true type: object pending_transaction_history_data1: properties: amount: description: The amount of the hold. format: int64 minimum: 0 type: integer auto_post_at: description: The time the transaction will be automatically posted. format: date-time type: string avail_balance: description: >- The account "available balance" at the time this hold was created (to be deprecated) format: int64 type: integer available_balance: description: The account "available balance" at the time this hold was created format: int64 type: integer balance: description: The account balance at the time this hold was created format: int64 type: integer currency: description: ISO 4217 alphabetic currency code of the transfer amount type: string dc_sign: $ref: '#/components/schemas/dc_sign' effective_date: description: The effective date of the transaction once it gets posted format: date-time type: string expires_at: description: The date that at which this hold is no longer valid. format: date-time type: string external_data: $ref: '#/components/schemas/external_data' force_post: description: Whether or not the hold was forced (spending controls ignored) type: boolean idemkey: description: The idempotency key used when initially creating this hold. type: string indefinite: description: >- If true, the hold will not expire automatically. The hold remains active until it is explicitly released or posted. type: boolean memo: description: A short note to the recipient type: string network: description: The network this transaction is associated with type: string operation: enum: - hold_new - hold_increase - hold_decrease - hold_replace - hold_decline - hold_cancel - hold_post - hold_expire type: string reason: description: >- If a hold has been declined or modified, this will include the reason. type: string req_amount: description: The requested amount, in the case of hold modifications. format: int64 minimum: 0 type: integer risk_info: $ref: '#/components/schemas/risk_info' status: description: The status of the hold. enum: - PENDING - REPLACED - DECLINED - RELEASED - PARTCLEARED - EXPIRED - CLEARED - INTERNAL_ERROR type: string subtype: description: >- The specific transaction type. For example, for `ach`, this may be "outgoing_debit". type: string total_amount: description: >- The total amount of the hold. This may be different than `amount` in the case where a hold increase or decrease was requested. format: int64 minimum: 0 type: integer transaction_id: description: >- The uuid of the transaction that this pending transaction originated from, if any. This is primary used when a transaction "posts", but a subset of the amount reserved until a future settlement date. format: uuid type: string transaction_time: description: The time the transaction occurred. format: date-time type: string type: description: The general type of transaction. For example, "card" or "ach". type: string user_data: $ref: '#/components/schemas/user_data' was_partial: description: Does this hold represent a partial debit (or credit)? type: boolean required: - memo - type - subtype - operation - idemkey - expires_at - effective_date - total_amount - amount - req_amount - dc_sign - currency - network - was_partial - force_post - status - reason - balance - avail_balance - available_balance - transaction_time - auto_post_at title: A pending transaction history 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 unprocessable_entity: content: application/problem+json: schema: $ref: '#/components/schemas/error' description: Unprocessable entity request response internal_server_error: content: application/json: schema: $ref: '#/components/schemas/error' description: Internal server error securitySchemes: bearerAuth: bearerFormat: api_key scheme: bearer type: http ````