Transactions with Clearing Accounts

Creating transactions with clearing accounts

To fund/withdraw from a clearing account, you will need to create a transaction with one of our payment products.

For example, to fund an account via ACH, please create an ACH-US node with the user’s relevant bank account information, then create a transaction with our ACH Product.

See below for the full list of transaction methods available for clearing accounts.

Transaction Method
Fund
Withdraw

Subnets (Account/Routing Number Issuance)

NO

NO

ACH

YES

YES

WIRE

--

YES

CHECKS

--

NO

CARD PROCESSING

YES

NO

CARD ISSUANCE

YES

NO

Transfer to other Synapse Accounts

YES

YES

Below is an example transaction for your convenience. Please refer to the appropriate payment product page for relevant details, including return/chargeback timelines.

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 :
integer 0

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/5bbbb1d0cb441500be52b114/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": "CLEARING-US",
    "id": "5bbbb1d0cb441500be52b114"
  },
  "amount": {
    "amount": 58.28,
    "currency": "USD"
  },
  "extra": {
    "ip": "127.0.0.1",
    "note": "Test transaction"
  }
}
from_node= 5bbbb1d0cb441500be52b114
body= {
  "to": {
    "type": "CLEARING-US",
    "id": "5bbbb1d0cb441500be52b114"
  },
  "amount": {
    "amount": 58.28,
    "currency": "USD"
  },
  "extra": {
    "ip": "127.0.0.1",
    "note": "Test transaction"
  }
}

user.create_trans(from_node, body)
user.createTransaction('<NODE_ID>', {
  to: {
    type: 'CLEARING-US',
    id: '<CLEARING-US_NODE_ID>'
  },
  amount: {
    amount: 100.1,
    currency: 'USD'
  },
  extra: {
    ip: '127.0.0.1',
    note: 'Test transaction'
  }
});
from_node= “5bbbb1d0cb441500be52b114”
body= {
  "to": {
    "type": "CLEARING-US",
    "id": "5bbbb1d0cb441500be52b114"
  },
  "amount": {
    "amount": 58.28,
    "currency": "USD"
  },
  "extra": {
    "ip": "127.0.0.1",
    "note": "Test transaction"
  }
}

user.create_transaction(node_id: from_node, payload: body)
$to = (object)[
   "type" => "CLEARING-US",
   "id" => '5bbbb1d0cb441500be52b114'
];
$amount = (object)[
   "amount" => 22.1,
   "currency" => "USD"
];
$extra = (object)[
   "ip" => "::1"
];
$body = (object)[
   "to" => $to,
   "amount" => $amount,
   "extra" => $extra
];
$nodeid = '5c6468aa7b08ab8e4fe658d9';
$trans = $user->create_trans($nodeid, $body);
nodeID := “5bbbb1d0cb441500be52b114”
body := `{
  "to": {
    "type": "CLEARING-US",
    "id": "5bbbb1d0cb441500be52b114"
  },
  "amount": {
    "amount": 58.28,
    "currency": "USD"
  },
  "extra": {
    "ip": "127.0.0.1",
    "note": "Test transaction"
  }
}`

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

EXAMPLE RESPONSE

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

Subscribe to Webhooks

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