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 Synctera Pay templates name: SyncteraPay - description: Apple Pay APIs name: Apple Pay - description: Request to create and manage accounts name: Accounts - 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: 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 payments name: ACH - description: Simulate receiving ACH transactions and returns name: ACH Transaction Simulations - 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: Requests to create and manage webhooks name: Webhooks - 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 documents. name: Documents - description: Request to create and manage edd name: Trust - description: Requests to calculate and manage CRR name: CRR - 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 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: 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: 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 paths: /cards/digital_wallet_tokens/{digital_wallet_token_id}: summary: Digital Wallet Token description: > The Digital Wallet token object represents your card's digital wallet token(s). patch: tags: - Digital Wallet Tokens summary: Update Digital Wallet Token's life cycle status description: > The status of a digital wallet token can be updated as, ACTIVE to SUSPENDED, SUSPENDED to ACTIVE, ACTIVE to TERMINATED or SUSPENDED to TERMINATED. NB: Digital wallet tokens cannot be created outside of production. operationId: updateDigitalWalletTokenStatus parameters: - $ref: '#/components/parameters/digital_wallet_token_id' - $ref: '#/components/parameters/idempotency_key' requestBody: content: application/json: schema: $ref: '#/components/schemas/digital_wallet_token_edit_request' description: Update Digital wallet token status required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/digital_wallet_token_response' description: Digital wallet token Status updated '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: digital_wallet_token_id: in: path name: digital_wallet_token_id required: true schema: $ref: '#/components/schemas/digital_wallet_token_id' 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: digital_wallet_token_edit_request: properties: status: description: The status indicating the digital wallet token lifecycle state enum: - ACTIVE - SUSPENDED - TERMINATED type: string required: - status type: object digital_wallet_token_response: properties: approved_time: example: '2010-05-06T12:23:34.321Z' format: date-time type: string card_id: description: Card ID of the Digital wallet Token example: 7d943c51-e4ff-4e57-9558-08cab6b963c7 format: uuid type: string device: $ref: '#/components/schemas/device' device_id: deprecated: true description: The user’s Android device ID; the device’s unique identifier. maxLength: 124 type: string device_type: deprecated: true description: Type of the device where the Digital Wallet Token is used in enum: - MOBILE_PHONE - WATCH - TABLET - MOBILE_PHONE_OR_TABLET - VEHICLE - APPLIANCE - LAPTOP - GAMING_DEVICE - UNKNOWN type: string id: description: Digital Wallet Token ID example: 7d943c51-e4ff-4e57-9558-08cab6b963c7 format: uuid type: string last_updated_time: example: '2010-05-06T12:23:34.321Z' format: date-time type: string processor_data: description: Raw data from processor. type: object removed_from_wallet_time: description: >- The time that the token was removed from a wallet. Tokens make remain active after being removed from a wallet. example: '2010-05-06T12:23:34.321Z' format: date-time type: string requested_time: example: '2010-05-06T12:23:34.321Z' format: date-time type: string state: $ref: '#/components/schemas/digital_wallet_token_state' tenant: $ref: '#/components/schemas/tenant_id' token_reference_id: description: >- Unique identifier of the digital wallet token within the card network. type: string type: description: >- Type of the Digital Wallet. Can be one of APPLE_PAY, ANDROID_PAY, SAMSUNG_PAY or something else when cards are added on file to a merchant. example: APPLE_PAY type: string required: - tenant type: object digital_wallet_token_id: description: The unique identifier of a digital wallet token example: 7d943c51-e4ff-4e57-9558-08cab6b963c7 format: uuid type: string device: description: Contains device informations. properties: device_id: description: The user’s Android device ID; the device’s unique identifier. maxLength: 124 type: string ip_address: description: IP address of the device. example: 1.12.123.255 type: string location: description: Location of the device. example: +22.20/-159.50 type: string name: description: Name of the device. type: string token: description: Unique identifier of the device type: string type: $ref: '#/components/schemas/device_type_response' type: object digital_wallet_token_state: description: Current status of the Digital Wallet Token enum: - REQUESTED - REQUEST_DECLINED - ACTIVE - SUSPENDED - TERMINATED type: string 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 device_type_response: description: Type of the device where the Digital Wallet Token is used in enum: - MOBILE_PHONE - WATCH - TABLET - MOBILE_PHONE_OR_TABLET - VEHICLE - APPLIANCE - LAPTOP - GAMING_DEVICE - UNKNOWN_DEVICE type: string 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 ````