Synapse

  • Guides
  • API Ref
  • FAQs
  • Blog
  • Status
  • Support

Synapse Developer Hub

Welcome to the Synapse Developer Hub. Here you will find comprehensive guides and documentation to help you start working with the Synapse API as quickly as possible. If you need any assistance, we are always here to help!

v3.1.1
  • v3.1.1stable
HomeGuidesRecipesAPI RefReferenceChangelogDiscussionsPage Not FoundSearch{{ state.current().meta.title }}API Logs
    HomeGuidesAPI Ref
discard

Introduction

  • Welcome to Synapse Docs
  • Getting Your Feet Wet
  • Customer Lifecycle with Synapse
    • Physical Card Issuance Integration
  • Best Practices
  • Security Best Practices
  • Contact Us
  • API Endpoint Report
  • Resource Library
    • HTTP Status Codes
    • Error Status Codes
    • Error Messages
    • Transaction Status Codes
    • Transaction Queue Codes
    • Transaction Cancellation Codes
    • ACH Return Codes
    • Card Issuance Return Codes
    • Card Processing (Interchange) Response Codes
    • Check/RDC Return Codes
    • Wire Return Codes
    • Node Types
    • Node Statuses
    • Allowed Status Code
    • Subnet Statuses
    • Native Card Issuance Transaction Types & MCC Codes
    • Native Card Issuance Error Codes & Transaction Status Notes
    • Native Card Issuance Risk Reasons
    • Sandbox Test Values
    • Account Aggregation Sandbox Values
    • Account Aggregation Errors
    • User Permissions
    • User Permission Codes (Reason Codes)
    • EDD User Flag Codes
    • Business User EDD Reason Codes
    • Physical Document Types
    • Physical Document Verification Invalid Reason Codes

Users and KYC (Documentation and Verification)

  • KYC and User Overview
    • User Authentication
    • KYC Document Categories
    • KYC Best Practices
    • How We Check (Validate) KYC
    • Sanctions Tiers and Watchlists Explained
    • Enhanced Due Diligence Process
    • Business User Enhanced Due Diligence
    • KYC FAQs
  • Base Documents (Base Docs)
    • Address Verification
  • Physical Documents
    • Photo ID Requirements
    • Video Auth Requirements
    • Government IDs
    • Other Physical Docs
    • Generate UBO/Reg GG
    • Proof of Address
  • Virtual Documents
  • Social Documents
  • Sub-Document Statuses
  • ID Score

Accounts

  • Accounts Main Page
    • Account Characteristics
    • How Accounts Work Behind the Scenes
    • Earned Interest for User Accounts
  • Deposit Accounts
    • [LEGACY] DEPOSIT-US
  • Interest Bearing (Savings) Accounts
  • Custody Accounts
  • FBO Accounts
  • Clearing Accounts
  • Reserve Accounts
  • Escrow Accounts
  • Brokerage Accounts
  • Crypto Accounts (Wallet)
  • Ledger (IOU) Accounts

Payments

  • Payments Main Page
    • Payments Behind the Scenes
    • Characteristics of Transactions
  • ACH
    • Linking ACH Accounts
  • Wires
    • Linking Wire Accounts
  • Internal Transfers
  • Card Processing
    • Linking a Card
    • Chargeback Disputes
  • BillPay (RPPS)
    • Linking RPPS Accounts
  • Checks (Legacy BillPay)
    • Link Check Recipient
  • RDC (Remote Deposit Capture)
    • RDC Submission Suggestions
  • Mitigating Transaction Risks
    • General Risk
    • ACH Risk
    • Card Processing Risk
    • RDC Risk

Native Card Issuance

  • Native Card Issuance Main Page
  • Best Practices
  • Common Mistakes
  • Pre-Auth & Provisional Credit
  • Card Transaction Dispute
  • Transaction Decisioning and Instant Auth
  • Mobile Wallets and Tokenization
  • Native Card Revenue
  • Premium Tier Card Features
  • FAQs
  • Instant Provisioning with Google, Apple, and Samsung Wallet

Lending

  • Lending Main Page
  • Loan Basics
  • Loan Decisioning
  • Loan Servicing
  • Loan Interest
  • Loan Delinquency
  • Best Practices
  • Common Mistakes

Advances

  • Advances Main Page

Data Services

  • Account Aggregation
  • Enrichment
    • Implementing the Enrichment Service

Chatbot

  • Chatbot Main Page
    • Desktop Integration
    • Callback Functions
    • Mobile App Integration
    • Customization
  • Chatbot Router
    • Flows
  • Chatbot Bank Logins (Account Aggregation)
    • Flows
    • Logic Tree
  • Chatbot Interchange
    • Flows
  • Chatbot Card Management
    • Flows
  • Chatbot EDD
    • Flows

UI as a Service

  • Cards UI

Legal

  • Marketing and Disclosure Guidelines

Node Add On Products

  • Add on Products
  • Statements
  • Account & Routing Numbers (Subnet)
  • Native Card Issuance
  • eCash Barcode

Client Dashboard

  • Client Dashboard Guide
    • Profile
    • Support
  • Chatbot Dashboard
  • Dashboard Tabs
    • Users Tab
    • Agents Tab
  • Subnets
  • Troubleshooting and FAQs

Introduction

  • Welcome to Synapse Docs
  • Getting Your Feet Wet
  • Customer Lifecycle with Synapse
    • Physical Card Issuance Integration
  • Best Practices
  • Security Best Practices
  • Contact Us
  • API Endpoint Report
  • Resource Library
    • HTTP Status Codes
    • Error Status Codes
    • Error Messages
    • Transaction Status Codes
    • Transaction Queue Codes
    • Transaction Cancellation Codes
    • ACH Return Codes
    • Card Issuance Return Codes
    • Card Processing (Interchange) Response Codes
    • Check/RDC Return Codes
    • Wire Return Codes
    • Node Types
    • Node Statuses
    • Allowed Status Code
    • Subnet Statuses
    • Native Card Issuance Transaction Types & MCC Codes
    • Native Card Issuance Error Codes & Transaction Status Notes
    • Native Card Issuance Risk Reasons
    • Sandbox Test Values
    • Account Aggregation Sandbox Values
    • Account Aggregation Errors
    • User Permissions
    • User Permission Codes (Reason Codes)
    • EDD User Flag Codes
    • Business User EDD Reason Codes
    • Physical Document Types
    • Physical Document Verification Invalid Reason Codes

Users and KYC (Documentation and Verification)

  • KYC and User Overview
    • User Authentication
    • KYC Document Categories
    • KYC Best Practices
    • How We Check (Validate) KYC
    • Sanctions Tiers and Watchlists Explained
    • Enhanced Due Diligence Process
    • Business User Enhanced Due Diligence
    • KYC FAQs
  • Base Documents (Base Docs)
    • Address Verification
  • Physical Documents
    • Photo ID Requirements
    • Video Auth Requirements
    • Government IDs
    • Other Physical Docs
    • Generate UBO/Reg GG
    • Proof of Address
  • Virtual Documents
  • Social Documents
  • Sub-Document Statuses
  • ID Score

Accounts

  • Accounts Main Page
    • Account Characteristics
    • How Accounts Work Behind the Scenes
    • Earned Interest for User Accounts
  • Deposit Accounts
    • [LEGACY] DEPOSIT-US
  • Interest Bearing (Savings) Accounts
  • Custody Accounts
  • FBO Accounts
  • Clearing Accounts
  • Reserve Accounts
  • Escrow Accounts
  • Brokerage Accounts
  • Crypto Accounts (Wallet)
  • Ledger (IOU) Accounts

Payments

  • Payments Main Page
    • Payments Behind the Scenes
    • Characteristics of Transactions
  • ACH
    • Linking ACH Accounts
  • Wires
    • Linking Wire Accounts
  • Internal Transfers
  • Card Processing
    • Linking a Card
    • Chargeback Disputes
  • BillPay (RPPS)
    • Linking RPPS Accounts
  • Checks (Legacy BillPay)
    • Link Check Recipient
  • RDC (Remote Deposit Capture)
    • RDC Submission Suggestions
  • Mitigating Transaction Risks
    • General Risk
    • ACH Risk
    • Card Processing Risk
    • RDC Risk

Native Card Issuance

  • Native Card Issuance Main Page
  • Best Practices
  • Common Mistakes
  • Pre-Auth & Provisional Credit
  • Card Transaction Dispute
  • Transaction Decisioning and Instant Auth
  • Mobile Wallets and Tokenization
  • Native Card Revenue
  • Premium Tier Card Features
  • FAQs
  • Instant Provisioning with Google, Apple, and Samsung Wallet

Lending

  • Lending Main Page
  • Loan Basics
  • Loan Decisioning
  • Loan Servicing
  • Loan Interest
  • Loan Delinquency
  • Best Practices
  • Common Mistakes

Advances

  • Advances Main Page

Data Services

  • Account Aggregation
  • Enrichment
    • Implementing the Enrichment Service

Chatbot

  • Chatbot Main Page
    • Desktop Integration
    • Callback Functions
    • Mobile App Integration
    • Customization
  • Chatbot Router
    • Flows
  • Chatbot Bank Logins (Account Aggregation)
    • Flows
    • Logic Tree
  • Chatbot Interchange
    • Flows
  • Chatbot Card Management
    • Flows
  • Chatbot EDD
    • Flows

UI as a Service

  • Cards UI

Legal

  • Marketing and Disclosure Guidelines

Node Add On Products

  • Add on Products
  • Statements
  • Account & Routing Numbers (Subnet)
  • Native Card Issuance
  • eCash Barcode

Client Dashboard

  • Client Dashboard Guide
    • Profile
    • Support
  • Chatbot Dashboard
  • Dashboard Tabs
    • Users Tab
    • Agents Tab
  • Subnets
  • Troubleshooting and FAQs

Getting Started

  • API Initialization
  • API Rate Limits
  • Client Libraries
  • Encrypting Sensitive Information
  • Common Errors
  • List of Codes

Miscellaneous

  • post
    Verify Address
  • post
    Verify Routing Number

Users

  • get
    View All Users
  • get
    View User
  • get
    View User w/ Full Dehydrate
  • post
    Create User w/ KYC
  • post
    Create User w/o KYC
  • patch
    Update User Status
  • patch
    Remove User Information
  • get
    Get Duplicate Users
  • patch
    Swap Duplicate Users
  • patch
    Flag User

Documents (KYC)

  • Base Documents
  • patch
    Add Base Documents
  • patch
    Update Base Documents
  • patch
    Remove Base Document
  • Sub-Documents
  • patch
    Add Sub-Documents
  • patch
    Update Sub-Documents
  • patch
    Remove Sub-Document
  • patch
    Add 2FA Device
  • patch
    Verify 2FA Device
  • patch
    Add Mailing Address
  • patch
    Generate UBO/Reg GG
  • KYC Sandbox Test Values

Fingerprints

  • post
    Register New Fingerprint
  • post
    Select 2FA Device
  • post
    Verify 2FA PIN

Keys

  • get
    Issue Public Key
  • post
    Issue OAuth Key

Nodes

  • get
    View All Platform Nodes
  • get
    View All User Nodes
  • get
    View User Node
  • post
    Agreement (Preview)
  • post
    Create Node
  • patch
    Update Node
  • delete
    Delete Node
  • More on Nodes

Subnets

  • get
    View User Subnets
  • get
    View Node Subnets
  • More on Subnet Statuses

Subnets - AC/RT

  • get
    View AC/RT Account
  • post
    Issue AC/RT Numbers
  • patch
    Update AC/RT Subnet Status

Subnets - Native Card Issuance

  • get
    View Card
  • post
    Create Card
  • patch
    Set Pin
  • patch
    Ship Card
  • get
    View Card Shipment
  • delete
    Cancel Card Shipment
  • patch
    Update Card Status
  • patch
    Update Preferences
  • patch
    Dispute Transaction
  • get
    Find ATM Locations
  • get
    View Transaction
  • Transaction Decisioning and Instant Auth Webhook
  • post
    Instant Provisioning with Google, Apple, and Samsung Pay

Transactions

  • get
    View Platform Transactions
  • get
    View User Transactions
  • get
    View Node Transactions
  • get
    View Transaction
  • post
    Create Transaction
  • post
    Create Bulk Transactions
  • get
    Create Dummy Transaction
  • patch
    Comment on Transaction Status
  • delete
    Cancel Transaction
  • More on Transactions

Statements

  • get
    View User Statements
  • get
    View Node Statements
  • post
    Generate Node Statements

Subscriptions (Webhooks)

  • get
    View All Subscriptions
  • get
    View Subscription
  • post
    Create Subscription
  • patch
    Update Subscription
  • get
    View Webhook Logs
  • Webhook Format and HMAC Information
  • Webhook Logistics

Interchange (Card Processing)

  • get
    View Card Details
  • post
    Link Card
  • Unlink Card
  • patch
    Dispute Chargeback

ACH

  • get
    View ACH Account
  • post
    Link with AC/RT
  • post
    Link with External Account Aggregation Data
  • post
    Link with Bank Login (Account Aggregation)
  • post
    Verify with MFA
  • post
    Create ACH Transaction
  • patch
    Retry ACH Transaction
  • patch
    Verify Micro-Deposits
  • patch
    Reinitiate Micro-Deposits
  • patch
    Reauthorize Account
  • Unlink ACH Account
  • get
    View All Institutions
  • Bank Logins Resources

BillPay (RPPS)

  • get
    View RPPS Account
  • post
    Link with Biller ID
  • post
    Create RPPS Transaction
  • get
    View Billers

Checks

  • get
    View Check Recipient
  • post
    Create Check Recipient
  • post
    Fund & Send a Check
  • delete
    Stop Check

eCash

  • post
    Generate Barcode

Clearing Accounts

  • get
    View Clearing Account
  • post
    Create Clearing Account
  • post
    Fund/Withdraw a Clearing Account

Crypto Wallet

  • get
    View Crypto Wallet
  • post
    Create Crypto Wallet
  • post
    Buy/Sell Crypto
  • get
    View Crypto Quotes
  • get
    View Crypto Market Data

Custody Accounts

  • get
    View Custody Account
  • post
    Create Custody Account

Deposit Accounts

  • get
    View Deposit Account
  • post
    Create Deposit Account
  • post
    Create Interest Carrying Deposit Account
  • patch
    Update Deposit Account

Interest Bearing (Savings) Accounts

  • get
    View IB Account
  • post
    Create IB Account
  • post
    Fund/Withdraw IB Account

IOU Accounts (Ledgering)

  • get
    View IOU Account
  • post
    Create IOU Account

Loans

  • get
    View Loan Details
  • post
    Make a Loan Payment
  • patch
    Change Payment Node
  • get
    View Loan Reserve

Loans (One-Time)

  • post
    (Preview) One-Time Loan
  • post
    Apply for One-Time Loan
  • patch
    Change Payment Node
  • patch
    Change Payment Date
  • patch
    Toggle AutoPay
  • patch
    Deactivate One-Time Loan

Loans (Revolving)

  • post
    (Preview) Revolving Loan
  • post
    Apply for Revolving Loan
  • patch
    Update Credit Limit
  • patch
    Terminate Revolving Loan

Advances

  • post
    Make An Advance Payment
  • get
    View Advance Details
  • patch
    Change Payment Node

Advances (One-Time)

  • post
    (Preview) One-Time Advance
  • post
    Apply for One-Time Advance
  • patch
    Change Payment Date
  • patch
    Deactivate Advance

RDC (Remote Deposit Check)

  • post
    Create RDC Transaction

Subaccounts (FBO)

  • get
    View Subaccount
  • post
    Create Subaccount

Trade Wallet

  • get
    View Trade Account
  • post
    Create Trade Account
  • post
    Buy/Sell Securities
  • get
    View Trade Market Data

Wires

  • get
    View Wire Account (Domestic)
  • get
    View Wire Account (International)
  • post
    Link Wire Account (Domestic)
  • post
    Link Wire Account (International)

Account Aggregation

  • get
    List Bank Coverage
  • post
    Link
  • post
    Link MFA Step
  • get
    Refresh
  • get
    View Last Refresh or Sync

Enrichment

  • get
    View Merchant Profile

Deprecated API Ref Pages

  • Explanation of Section
  • post
    [Deprecated] Create Transaction w/ Fee Node
  • delete
    [Deprecated] Delete Card
Powered by