Open A Ledger Account

Create an IOU account with Synapse

Synapse’s IOU accounts function as a ledgering system to track non-monetary payments made to users. An IOU node functions like a real node that is created for a user, but is not an actual account created with Evolve bank. Its purpose is to ledger the movement of funds and users.

Examples of using an IOU node:

  • Sending or receiving gift card value
  • Sending a wire outside of Synapse’s system, but still wanting to keep track of where it’s going or who is receiving the funds
  • Sending or receiving cryptocurrency value between users

Even when the dollar value isn’t being sent to users, it is still important to keep track of the non-monetary transactions. Users undergo screens for sanctions and screening list matches, and often, users with money-laundering goals will use services like gift cards to transaction away from the spotlight of ACH or interchange. For this reason, even users who don’t send or receive monetary funds should be set up as users with IOU nodes for each transaction

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 IOU node under

BODY PARAMETER

type :
required
string

Type of node you wish to add

info.nickname :
required
string

Nickname for the node

info.balance.currency :
required
string

Currency of 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

EXAMPLE REQUEST

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


{
  "type": "IOU",
  "info":{
      "nickname":"My IOU Node",
      "balance":{
          "currency":"USD"
      }
    },
  "extra": {
    "supp_id": "ABC124"
  },
  "is_active": true
}
body = {
  "type": "IOU",
  "info":{
      "nickname":"My IOU Node",
      "balance":{
          "currency":"USD"
      }
    },
    ...
}

user.create_node(body, idempotency_key='123456')
const body = {
  "type": "IOU",
  "info":{
      "nickname":"My IOU Node",
      "balance":{
          "currency":"USD"
      }
    },
  "extra": {
    "supp_id": "ABC124"
  },
  "is_active": true
}

user.createNode(body);
body = {
  "type": "IOU",
  "info":{
      "nickname":"My IOU Node",
      "balance":{
          "currency":"USD"
      }
    },
  "extra": {
    "supp_id": "ABC124"
  },
  "is_active": true
}
user.create_node(payload: body)
$balance = (object)[
   "currency" => "USD"
];
$extra = (object)[
   "supp_id" => "ABC124"
];
$info= (object) [
   "nickname" => "My IOU Node",
   "balance" => $balance
];
$body = (object) [
   'type' => 'IOU',
   'info' => $info,
   'extra' => $extra,
   'is_active' => true
];

$user->create_node($body );
body := `{
  "type": "IOU",
  "info":{
      "nickname":"My IOU Node",
      "balance":{
          "currency":"USD"
      }
    },
  "extra": {
    "supp_id": "ABC124"
  },
  "is_active": true
}`

data, err := user.createNode(body)

EXAMPLE RESPONSE

{
    "error_code": "0",
    "http_code": "200",
    "limit": 20,
    "node_count": 1,
    "nodes": [
        {
            "_id": "5bbba20d7b11c300ae9045a1",
            "_links": {
                "self": {
                    "href": "https://uat-api.synapsefi.com/v3.1/users/5bb6ab05472e2500adffad5a/nodes/5bbba20d7b11c300ae9045a1"
                }
            },
            "allowed": "CREDIT-AND-DEBIT",
            "client": {
                "id": "5ade26b4567a900029e2afd2",
                "name": "YY Test Account"
            },
            "extra": {
                "note": null,
                "other": {},
                "supp_id": "ABC124"
            },
            "info": {
                "balance": {
                    "amount": 0,
                    "currency": "USD"
                },
                "monthly_withdrawals_remaining": null,
                "name_on_account": " ",
                "nickname": "My IOU Node"
            },
            "is_active": true,
            "timeline": [
                {
                    "date": 1539023373551,
                    "note": "Node created."
                }
            ],
            "type": "IOU",
            "user_id": "5bb6ab05472e2500adffad5a"
        }
    ],
    "page_count": 1,
    "success": true
}

Subscribe to Webhooks

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

Open A Ledger Account


Create an IOU account with Synapse

Suggested Edits are limited on API Reference Pages

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