View IB Account

Get details on the Interest Bearing Account

user_id :

The user ID of the user

node_id :

The node ID of the node


GET /v3.1/users/5bb6ab05472e2500adffad5a/nodes/5bb6fbd085411800baebc9a3 HTTP/1.1
X-SP-USER: oauth_q0gEuw3NO08DPfe7nJxsVCISTjzvYdltiKcMAFWp|n38dj3h8NE393bv24ovoRY34kd62
Content-Type: application/json
ib_deposit_node_id = 5bb6fbd085411800baebc9a3
const ibDepositNodeID = “5bb6fbd085411800baebc9a3”;

$nodeid = '5c6468aa7b08ab8e4fe658d9';
$force_refresh = null;
$user->get_node($nodeid, $full_dehydrate, $force_refresh);
nodeID := “5bb6fbd085411800baebc9a3”

data, err := user.GetNode(nodeID)


    "_id": "5bb6fbd085411800baebc9a3",
    "_links": {
        "self": {
            "href": ""
    "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": 6,
        "name_on_account": " ",
        "nickname": "My Interest Bearing Account"
    "is_active": true,
    "timeline": [
            "date": 1538718672389,
            "note": "Node created."
    "type": "IB-DEPOSIT-US",
    "user_id": "5bb6ab05472e2500adffad5a"

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.
  • Negative Balances: Balances can go negative due to returns and chargebacks. When this happens, please prompt the user to fund their account. Please be aware that we reconcile negative balances from your reserve account at the end of each month.
  • Low Balances: If a user wants an 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.
  • Available Withdrawals: Pay attention to available_withdrawals. Once this hits 0, you will not be able to withdraw from the account until the next calendar month begins.
  • Failed Webhooks: If a webhook fails to send, we will try to send the request every 10 minutes until we are successful in delivering the webhook, up to 24 hours. After that, we will log the webhook and make it available for viewing on our dashboard for 15 days.

View IB Account

Get details on the Interest Bearing Account

Suggested Edits are limited on API Reference Pages

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