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: Request to create and manage statements name: Statements - description: Create and manage Cash Order and Cash Deposit transfers name: Cash Orders and Deposits (alpha) - description: Create and manage sweep configurations name: Configs - 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: 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 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: 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: 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: Create and manage Synctera Pay templates name: SyncteraPay - description: Apple Pay APIs name: Apple Pay - 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 - 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: 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 payment_schedules name: Cronut - description: Create and manage EFT Canada transfers name: EFT Canada (Beta) - description: FDX authentication and data transfer using Plaid Core Exchange name: Plaid Core Exchange (beta) - 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: 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 and manage payments name: ACH - description: Simulate receiving ACH transactions and returns name: ACH Transaction Simulations - description: Requests to create and manage webhooks name: Webhooks - description: Create and manage documents. name: Documents paths: /cards/gateways: summary: Authorization Gateway Configuration description: | The Gateway object represents the Authorization gateway configuration. post: tags: - Cards summary: Create Gateway description: | Create a new Authorization Gateway Configuration operationId: createGateway parameters: - $ref: '#/components/parameters/idempotency_key' requestBody: content: application/json: schema: $ref: '#/components/schemas/create_gateway_request' description: Create a new Authorization Gateway Configuration required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/gateway_response' description: New Authorization Gateway Configuration created '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' callbacks: gateway_authorization: '{$request.body#/url}': post: requestBody: content: application/json: schema: $ref: '#/components/schemas/gateway_authorization' required: true responses: '200': description: | Approve the funding request. '402': description: > Decline the funding request. *Note: while HTTP Code 402 is conventional, any code other than 200 will also be interpreted as a decline. method: post type: path path: '{$request.body#/url}' 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: create_gateway_request: properties: card_products: description: >- List of Card Product unique identifiers that will utilize the Gateway items: example: 7d943c51-e4ff-4e57-9558-08cab6b963c7 format: uuid type: string type: array custom_headers: $ref: '#/components/schemas/gateway_custom_headers' is_active: description: Current status of the Authorization gateway type: boolean standin: $ref: '#/components/schemas/gateway_standin' url: description: URL of the Authorization gateway format: uri maxLength: 1000 type: string required: - is_active - url - card_products type: object gateway_response: properties: card_products: description: >- List of Card Product unique identifiers that will utilize the Gateway items: example: 7d943c51-e4ff-4e57-9558-08cab6b963c7 format: uuid type: string type: array creation_time: description: The timestamp representing when the gateway config request was made example: '2010-05-06T12:23:34.321Z' format: date-time readOnly: true type: string custom_headers: $ref: '#/components/schemas/gateway_custom_headers' id: description: Gateway ID example: 7d943c51-e4ff-4e57-9558-08cab6b963c7 format: uuid type: string is_active: description: Current status of the Authorization gateway type: boolean last_updated_time: description: >- The timestamp representing when the gateway config was last modified at example: '2010-05-06T12:23:34.321Z' format: date-time readOnly: true type: string standin: $ref: '#/components/schemas/gateway_standin' tenant: $ref: '#/components/schemas/tenant_id' url: description: URL of the Authorization gateway format: uri maxLength: 1000 type: string required: - id - is_active - url - card_products - creation_time - last_updated_time - tenant type: object gateway_authorization: description: Request sent to gateway for authorization. properties: account_id: description: Unique identifier of the account. example: 7d943c51-e4ff-4e57-9558-08cab6b963c7 format: uuid type: string acquirer_reference_id: type: string amount: $ref: '#/components/schemas/gateway_authorization_amount' balance: $ref: '#/components/schemas/gateway_authorization_balance' banknet_reference_id: type: string bin: $ref: '#/components/schemas/gateway_authorization_bin' card_category: type: string card_format: $ref: '#/components/schemas/gateway_authorization_card_format' card_id: description: Unique identifier of the card. example: 7d943c51-e4ff-4e57-9558-08cab6b963c7 format: uuid type: string customer_id: description: Unique identifier of the customer. example: 7d943c51-e4ff-4e57-9558-08cab6b963c7 format: uuid type: string dc_sign: type: string digital_wallet_token_id: description: Unique identifier of the digital wallet token. example: 7d943c51-e4ff-4e57-9558-08cab6b963c7 format: uuid type: string digital_wallet_token_reference_id: type: string enhanced_transaction: $ref: '#/components/schemas/gateway_authorization_enhanced_transaction' fees: $ref: '#/components/schemas/gateway_authorization_fees' id: description: Unique identifier assigned to each individual request. example: 7d943c51-e4ff-4e57-9558-08cab6b963c7 format: uuid type: string is_surcharge_free: description: Indicates if the transaction is surcharge free. type: boolean last_four: description: Last four digits of the card PAN. example: '1234' type: string merchant: $ref: '#/components/schemas/gateway_authorization_merchant' network: type: string network_fraud: $ref: '#/components/schemas/gateway_authorization_network_fraud' payment_channel: type: string pos: $ref: '#/components/schemas/gateway_authorization_pos' processor: $ref: '#/components/schemas/gateway_authorization_processor' processor_data: description: >- An unstructured JSON blob containing raw transaction data from the processor. type: object settlement_date: example: '2010-05-06T12:23:34.321Z' format: date-time type: string subnetwork: type: string three_ds_authentication_status: enum: - AUTHENTICATED - NOT_AUTHENTICATED - EXEMPT - ACQUIRER_EXEMPT type: string transaction_id: description: Unique identifier of the transaction. example: 7d943c51-e4ff-4e57-9558-08cab6b963c7 format: uuid type: string type: type: string user: $ref: '#/components/schemas/gateway_authorization_user' user_transaction_time: description: The time when the transaction occurred. example: '2010-05-06T12:23:34.321Z' format: date-time type: string verification: $ref: '#/components/schemas/gateway_authorization_verification' required: - customer_id - account_id - transaction_id - card_id - card_format - last_four - type - user_transaction_time - settlement_date - amount - balance - merchant - user - network_fraud - subnetwork - bin - processor - processor_data type: object gateway_custom_headers: additionalProperties: type: string description: > These key-value pairs define custom HTTP headers that will be included in every HTTP request to the gateway. Note that when updating this field, all key-value pairs will be replaced. They are not merged with existing data. type: object gateway_standin: properties: enabled: type: boolean type: object tenant_id: description: > The id of the tenant containing the resource. This is relevant for Fintechs that have multiple workspaces. example: abcdef_ghijkl type: string error: description: >- Synctera error responses in API v0 follow [RFC 7807](https://datatracker.ietf.org/doc/html/rfc7807). Following that standard, the field for a machine-readable "error code" in API v0 is `type`. In our future API v1, we are phasing out RFC 7807 and adopting a custom error format. That format will be documented in our API v1 spec. But you may see some v0 error responses with a machine-readable `code` field while we are making the transition from v0 to v1. properties: code: description: >- An optional “sneak preview” of our future API v1 error responses. This is provided to give integrators a chance to work with our future error codes. Error codes for the same error may change between v0 and v1. 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: the HTTP status code for this response example: 400 type: integer title: description: > A human-readable string for this general category of error, which corresponds 1-to-1 with error types (`title` is the human-readable version of `type`). There can be multiple distinct titles for the same HTTP status code, and the same `title` can result in many different `detail` strings. This field will be removed in API v1. example: Bad Request Body type: string type: description: > A machine-readable string that identifies the error for programmatic use. This is a URI, i.e. a globally unique identifier. It is _not_ necessarily a URL, so do not expect it to resolve to a web page. You can use this whole string as an error code, or just everything after the last slash. This field will be removed in API v1. example: https://dev.synctera.com/errors/bad-request-body type: string title: Standard error response (RFC 7807 problem report) type: object gateway_authorization_amount: properties: amount: format: int64 type: integer approved_amount: format: int64 type: integer currency: type: string currency_conversion: $ref: '#/components/schemas/gateway_authorization_currency_conversion' total_pending_amount: format: int64 type: integer required: - approved_amount - total_pending_amount - amount - currency - currency_conversion type: object gateway_authorization_balance: properties: available_balance: format: int64 type: integer required: - available_balance type: object gateway_authorization_bin: properties: country_code: type: string id: format: uuid type: string required: - id - country_code type: object gateway_authorization_card_format: enum: - PHYSICAL - VIRTUAL type: string gateway_authorization_enhanced_transaction: properties: category: type: string enhanced_description: type: string enhanced_raw: items: $ref: >- #/components/schemas/gateway_authorization_enhanced_transaction_raw type: array required: - enhanced_description - category - enhanced_raw type: object gateway_authorization_fees: properties: acquirer_user_fee: format: int64 type: integer cross_border_issuer_fee: format: int64 type: integer currency_conversion_issuer_fee: format: int64 type: integer currency_conversion_user_fee: format: int64 type: integer interchange_fee: format: int64 type: integer issuer_fee: format: int64 type: integer network_fee: format: int64 type: integer pindebit_user_fee: format: int64 type: integer type: object gateway_authorization_merchant: properties: city: type: string country_code: type: string mcc: type: string mid: type: string name: type: string payment_facilitator_id: type: string postal_code: type: string state: type: string sub_merchant_id: type: string required: - mid - mcc - name - city - state - postal_code - country_code - sub_merchant_id - payment_facilitator_id type: object gateway_authorization_network_fraud: properties: transaction_risk_score: format: int32 type: integer type: object gateway_authorization_pos: properties: cardholder_verification_method: type: string cvv_presence: type: string pan_entry_mode: type: string pin_entry_mode: type: string pin_present: type: boolean terminal_capability: type: string terminal_id: type: string type: object gateway_authorization_processor: enum: - MARQETA - EPISODE_SIX type: string gateway_authorization_user: properties: metadata: additionalProperties: type: string type: object type: object gateway_authorization_verification: properties: online_security_transaction_code: type: string type: object gateway_authorization_currency_conversion: properties: conversion_rate: format: float type: number dynamic_currency_conversion: type: boolean original_amount: format: int64 type: integer original_currency_code: type: string original_currency_code_alpha: $ref: '#/components/schemas/currency_code' raw_original_amount: format: float type: number settlement_currency_conversion: $ref: >- #/components/schemas/gateway_authorization_settlement_currency_conversion type: object gateway_authorization_enhanced_transaction_raw: properties: amount: format: float nullable: true type: number categorized_by: format: int32 nullable: true type: integer category: nullable: true type: string category_guid: nullable: true type: string described_by: format: int32 nullable: true type: integer description: nullable: true type: string extended_transaction_type: nullable: true type: string id: nullable: true type: string is_bill_pay: nullable: true type: boolean is_direct_deposit: nullable: true type: boolean is_expense: nullable: true type: boolean is_fee: nullable: true type: boolean is_income: nullable: true type: boolean is_international: nullable: true type: boolean is_overdraft_fee: nullable: true type: boolean is_payroll_advance: nullable: true type: boolean is_subscription: nullable: true type: boolean memo: nullable: true type: string merchant_category_code: type: string merchant_guid: nullable: true type: string merchant_location_guid: nullable: true type: string original_description: nullable: true type: string type: nullable: true type: string type: object currency_code: description: ISO 4217 Alpha-3 currency code example: USD maxLength: 3 minLength: 3 type: string gateway_authorization_settlement_currency_conversion: properties: amount: format: int64 type: integer conversion_rate: format: float type: number currency_code: type: string currency_code_alpha: $ref: '#/components/schemas/currency_code' type: object responses: bad_request: content: application/problem+json: schema: $ref: '#/components/schemas/error' description: BadRequest unauthorized: content: application/problem+json: schema: $ref: '#/components/schemas/error' description: Unauthorized forbidden: content: application/problem+json: schema: $ref: '#/components/schemas/error' description: Forbidden error unprocessable_entity: content: application/problem+json: schema: $ref: '#/components/schemas/error' description: Unprocessable entity request response internal_server_error: content: application/problem+json: schema: $ref: '#/components/schemas/error' description: Internal server error securitySchemes: bearerAuth: bearerFormat: api_key scheme: bearer type: http ````