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!

Support

Recent Posts

Archive

Crypto Wallet Intro

With our cryptocurrency wallet product, you can use our banking infrastructure to buy, sell, and hold crypto. We integrate with exchanges to provide liquidity and hold crypto in custody, making buying and selling multiple coins as easy as funding a deposit account. Currently, we support only BTC and ETH for USD conversion. We are looking to add more cryptocurrencies in the future.

What is a cryptocurrency wallet?

In Synapse a cryptocurrency wallet is a custody account that can be funded via USD. Just by initiating a transaction to the CRYPTO-US node and indicating currency funds are instantly converted and stored. For withdrawing and cashing out, users just need to create a reverse transaction and they will be able to cash out at current market rates. Unlike other crypto wallets, our product is completely closed-loop. Users are not able to fund their wallets with their existing crypto or send the crypto they hold to outside wallets.

Node Type

Type

Default Permissions

Comment

CRYPTO-US

CREDIT-AND-DEBIT

A custody account that allows you to convert USD to crypto and withdraw into USD

Node Structure

_id:

string

Object ID of the node

_links.self.href:

string

HAL style link for the node

allowed:

string

Denotes the account standing. Look at the node permissions section below to learn more

client.id:

string

ID of the client that created the node

client.name:

string

Name of the client that created the node

info.nickname:

string

Any nickname/common name given to the node. Eg. Savings Node

info.name_on_account:

string

[Deprecated] Name of the user who owns the node

info.portfolio.BTC:

integer

Amount of BTC held in node

info.portfolio.ETH:

integer

Amount of ETH held in node

type:

string

Type of node

timeline:

array of objects

Array that tracks node updates as they occur

is_active:

booleantrue

If the node is indexed or marked deleted.

user_id:

string

ID of the user who owns the node

extra.supp_id:

string

Any supplied ID given by the client that created the node

Node Permissions

Every deposit account has the following permissions associated with them:

Permission

Comments

CREDIT-AND-DEBIT

Node can be used for sending and receiving funds

INACTIVE

Node has been disabled and cannot be used for any transactions

LOCKED

Node has been locked and cannot be used for any transactions. This can be used in the case of fraudulent activity.