Fund the Ledger Account

Create transactions to and from the ledger account

Send funds to an IOU node:

Funds can be sent to an IOU node from any Synapse account (DEPOSIT-US, SUBACCOUNT-US, CLEARING-US, CRYPTO-US, etc.)

API ENDPOINT

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

PATH PARAMETER

user_id:
required
string

ID of sender (user)

node_id:
required
string

ID of sending node

BODY PARAMETER

to.type:
required
string

Receiving node type

to.id:
required
string

Receiving node ID

amount.amount:
required
double

Amount user wishes to send

amount.currency:
required
string

Currency of the transaction amount

extra.ip:
required
string

IP address of the user device while creating transaction

extra.supp_id:
string

ID supplied to the transaction. Allows clients to track transactions based on specific events.

extra.group_id:
string

Group ID supplied to the transaction. Allows clients to track transactions based on specific events.

extra.note:
string

Memo tagged with the transaction

extra.process_on:
integer0

When the transaction should be processed. The value is the delta value. Which means when 1 is supplied it means that the transaction will be processed tomorrow.

extra.other.attachments:
array of strings

Array of padded base64 of attachments

fees[fee]:
double

Fee associated with the transaction

fees[note]:
string

Reason for the fee

fees[to].id:
string

Node ID where the fee would be credited when the transaction settled. Fee node has to be DEPOSIT-US type always

EXAMPLE REQUEST

POST /v3.1/users/5bb6ab05472e2500adffad5a/nodes/5bbba20d7b11c300ae9045a1/trans 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


{
  "to": {
    "type": "IOU",
    "id": "5bbba20d7b11c300ae9045a1"
  },
  "amount": {
    "amount": 124.99,
    "currency": "USD"
  },
  "extra": {
    "ip": "127.0.0.1",
    "note": "Test transaction"
  }
}
node_id = 5bbba20d7b11c300ae9045a1
body = {
  "to": {
    "type": "IOU",
    "id": "5bbba20d7b11c300ae9045a1"
  },
  "amount": {
    "amount": 124.99,
    "currency": "USD"
  },
  "extra": {
    "ip": "127.0.0.1",
    "note": "Test transaction"
  }
}

user.create_trans(node_id, body)
const fromNodeID = “5bbba20d7b11c300ae9045a1”;
const body = {
  "to": {
    "type": "IOU",
    "id": "5bbba20d7b11c300ae9045a1"
  },
  "amount": {
    "amount": 124.99,
    "currency": "USD"
  },
  "extra": {
    "ip": "127.0.0.1",
    "note": "Test transaction"
  }
};

user.createTransaction(fromNodeID, body);
node_id = “5bbba20d7b11c300ae9045a1”
body = {
  "to": {
    "type": "IOU",
    "id": "5bbba20d7b11c300ae9045a1"
  },
  "amount": {
    "amount": 124.99,
    "currency": "USD"
  },
  "extra": {
    "ip": "127.0.0.1",
    "note": "Test transaction"
  }
}

user.create_transaction(node_id: node_id ,payload: body)
$to = (object)[
   "type" => "IOU",
   "id" => 'to_node_id'
];
$amount = (object)[
   "amount" => 22.1,
   "currency" => "USD"
];
$extra = (object)[
   "ip" => "IP_address_of_user_device_while_creating_transaction"
];
$body = (object)[
   "to" => $to,
   "amount" => $amount,
   "extra" => $extra
];
$nodeid = '5c3d416f7b08ab0066ee8cae';
$user->create_trans($nodeid, $body);
nodeID := “5bbba20d7b11c300ae9045a1”
body := `{
  "to": {
    "type": "IOU",
    "id": "5bbba20d7b11c300ae9045a1"
  },
  "amount": {
    "amount": 124.99,
    "currency": "USD"
  },
  "extra": {
    "ip": "127.0.0.1",
    "note": "Test transaction"
  }
}`

data, err := user.CreateTransaction(nodeID, body)

EXAMPLE RESPONSE

{
    "_id": "5bbba42851a6ff00f96d8449",
    "_links": {
        "self": {
            "href": "https://uat-api.synapsefi.com/v3.1/users/5bb6ab05472e2500adffad5a/nodes/5bbba20d7b11c300ae9045a1/trans/5bbba42851a6ff00f96d8449"
        }
    },
    "_v": 2,
    "amount": {
        "amount": 124.99,
        "currency": "USD"
    },
    "client": {
        "id": "5ade26b4567a900029e2afd2",
        "name": "* YY Test Account"
    },
    "extra": {
        "asset": null,
        "created_on": 1539023911899,
        "encrypted_note": "",
        "group_id": null,
        "ip": "127.0.0.1",
        "latlon": "0,0",
        "note": "Test transaction",
        "process_on": 1539023911899,
        "same_day": false,
        "supp_id": ""
    },
    "fees": [
        {
            "fee": 0,
            "note": "Facilitator Fee",
            "to": {
                "id": "None"
            }
        }
    ],
    "from": {
        "id": "5bbba20d7b11c300ae9045a1",
        "nickname": "My IOU Node",
        "type": "IOU",
        "user": {
            "_id": "5bb6ab05472e2500adffad5a",
            "legal_names": [
                "Test User"
            ]
        }
    },
    "recent_status": {
        "date": 1539023911899,
        "note": "Transaction Created.",
        "status": "CREATED",
        "status_id": "1"
    },
    "timeline": [
        {
            "date": 1539023911899,
            "note": "Transaction Created.",
            "status": "CREATED",
            "status_id": "1"
        }
    ],
    "to": {
        "id": "5bbba20d7b11c300ae9045a1",
        "nickname": "My IOU Node",
        "type": "IOU",
        "user": {
            "_id": "5bb6ab05472e2500adffad5a",
            "legal_names": [
                "Test User"
            ]
        }
    }
}

Note #1 To add an addendum to the transaction on the user's bank statement, use the 'note' field. Notes are limited to 80 characters.

Note #2 Stay updated on the status of transactions with Transaction Statuses and Transaction Codes. In most cases, transactions will settle immediately.

Subscribe to Webhooks

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