Open a Crypto Wallet

Create a Crypto wallet with SynapseFI

After you create a user and add the necessary KYC (as listed on your spec sheet), you are ready to open an account CRYPTO-US. Please also remember to Oauth the user since you are performing an action on their behalf.

API ENDPOINT

https://uat-api.synapsefi.com/v3.1/users/:user_id/nodes

PATH PARAMETER

user_id :
required
string

The user ID of the user you wish to add the CRYPTO-US node under

BODY PARAMETER

type :
required
string

Type of node. This should be CRYPTO-US

info.nickname :
required
string

Nickname associated with the node

extra.supp_id :
string

Any ID you wish to register to the node

is_active :
boolean

If the node is indexed or marked deleted.

To create the crypto account, you will need to pass the user_id of the user you wish to add the crypto account under. In the body parameter, you will pass the type CRYPTO-US and the nickname of the account. Additional resources can be found here on creating an account (general node resource).

EXAMPLE REQUEST

POST /v3.1/users/5b62b0f84a973500675e5fab/nodes HTTP/1.1
Host: uat-api.synapsefi.com
X-SP-USER-IP: 127.0.0.1
X-SP-USER: oauth_R6NCa4SuDPYjhZELQ2wlyG7zncebfWBvIVrpTMgA|e83cf6ddcf778e37bfe3d48fc78a6502062fc
Content-Type: application/json

{
  "type": "CRYPTO-US",
  "info":{
      "nickname":"My CRYPTO Wallet"
  }
}
body = {
  "type": "CRYPTO-US",
  "info":{
      "nickname":"My CRYPTO Wallet"
  }
}

user.create_node( body)
const body = {
  "type": "CRYPTO-US",
  "info": {
      "nickname":"My CRYPTO Wallet"
  }
};

user.createNode(body);
body= {
  "type": "CRYPTO-US",
  "info":{
      "nickname":"My CRYPTO Wallet"
  }
}

user.create_node(payload: body)
$info= (object) [
   "nickname" => "My Crypto Wallet"
];
$body = (object) [
   'type' => 'CRYPTO-US',
   'info' => $info
];

$user->create_node($body);
body := `{
  "type": "CRYPTO-US",
  "info":{
      "nickname":"My CRYPTO Wallet"
  }
}`

data, err := user.CreateNode(body)

EXAMPLE RESPONSE

{
    "error_code": "0",
    "http_code": "200",
    "limit": 20,
    "node_count": 1,
    "nodes": [
        {
            "_id": "5b62b133739e400071fc2459",
            "_links": {
                "self": {
                    "href": "https://uat-api.synapsefi.com/v3.1/users/5b62b0f84a973500675e5fab/nodes/5b62b133739e400071fc2459"
                }
            },
            "allowed": "CREDIT-AND-DEBIT",
            "client": {
                "id": "589acd9ecb3cd400fa75ac06",
                "name": "SynapseFI"
            },
            "extra": {
                "note": null,
                "other": {
                    "access_token": "WA-YXFBCDZA9FX"
                },
                "supp_id": ""
            },
            "info": {
                "name_on_account": " ",
                "nickname": "My CRYPTO Wallet",
                "portfolio": {
                    "BTC": 0,
                    "ETH": 0
                }
            },
            "is_active": true,
            "timeline": [
                {
                    "date": 1533194544947,
                    "note": "Node created."
                }
            ],
            "type": "CRYPTO-US",
            "user_id": "5b62b0f84a973500675e5fab"
        }
    ],
    "page_count": 1,
    "success": true
}

A successful response will return a standard node object with the node id (_id). Fields unique to the Crypto account include access_token and portfolio.

Note: Portfolio is where you will see the amount of cryptocurrency held in the account.

Subscribe to Webhooks

We recommend that you subscribe to webhooks to stay updated on the status of nodes.

Open a Crypto Wallet


Create a Crypto wallet with SynapseFI

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.