Open a Clearing Account

Create a clearing account with SynapseFI

To open a clearing account please designate CLEARING-US for the type. Note that clearing accounts are typically attached to your platform's user (even though it is held in the bank's name). You will need to OAuth the user prior to performing actions on the user.

API ENDPOINT

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

PATH PARAMETER

user_id:
required
string

Object ID of the user an account is being created for

BODY PARAMETER

type:
required
string

Type of node. This should be CLEARING-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

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": "CLEARING-US",
  "info": {
    "nickname":"Clearing Account"
  }
}
body = {
  "type": "CLEARING-US",
  "info": {
    "nickname":"Clearing Account"
  }
}

user.create_node(body)
const body = {
  "type": "CLEARING-US",
  "info": {
    "nickname":"Clearing Account"
  }
};

user.createNode(body);
body= {
  "type": "CLEARING-US",
  "info": {
    "nickname":"Clearing Account"
  }
}

user.create_node(payload: body)
$info= (object) [
   "nickname" => "Clearing Account"
];
$body = (object) [
   'type' => 'CLEARING-US',
   'info' => $info
];

$user->create_node($body);
body := `{
  "type": "CLEARING-US",
  "info": {
    "nickname":"Clearing Account"
  }
}`

data, err := user.CreateNode(body)

EXAMPLE RESPONSE

{
    "error_code": "0",
    "http_code": "200",
    "limit": 20,
    "node_count": 1,
    "nodes": [
        {
            "_id": "5bbbb1d0cb441500be52b114",
            "_links": {
                "self": {
                    "href": "https://uat-api.synapsefi.com/v3.1/users/5bb6ab05472e2500adffad5a/nodes/5bbbb1d0cb441500be52b114"
                }
            },
            "allowed": "CREDIT-AND-DEBIT",
            "client": {
                "id": "5ade26b4567a900029e2afd2",
                "name": "YY Test Account"
            },
            "extra": {
                "note": null,
                "other": {},
                "supp_id": ""
            },
            "info": {
                "balance": {
                    "amount": 0,
                    "currency": "USD"
                },
                "monthly_withdrawals_remaining": null,
                "name_on_account": " ",
                "nickname": "Clearing Account"
            },
            "is_active": true,
            "timeline": [
                {
                    "date": 1539027408444,
                    "note": "Node created."
                }
            ],
            "type": "CLEARING-US",
            "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.

Things to Monitor:

  • **Account Status: Webhooks will alert you when an account’s status changes. This is helpful if a user’s account is locked or updated.

  • **Low Balances: If you need this account to maintain a minimum balance, you can monitor the balance and send automatic reminders to your users to fund the account when it needs to be topped up.