Salt Edge Integration

Aggregate held away financial account data globally




Salt Edge enables applications to connect with users' bank, credit card, loan, and investment accounts to pull in account details such as balances and transactions.

Setup

To get started, you'll first need to sign up with Salt Edge and get your client_id and client_secret. If you already have a Salt Edge account, you can go ahead and sign in to retrieve these values. We currently support the following Salt Edge statuses: Test (choose "Development" as the vendor environment on our admin) and Live (choose "Production" as the vendor environment on our admin). We do not support the Salt Edge Pending status (dummy accounts). View info on Salt Edge account statuses here.

Implementation

User Creation

Once you have Salt Edge credentials set up on the Integrations Admin, you can retrieve the Salt Edge widget to embed in your app or web page. The Salt Edge widget will manage user credential validation, multi-factor authentication, and error handling for each institution that Salt Edge supports to ensure that your end-user is able to pull data from the account that the've linked.

Create a user in Salt Edge for the client_id that was created in Nucleus. This will connect the Hydrogen user to the Salt Edge user. This process can also be automated through the Hydrogen Integration Admin settings if you wish to use Salt Edge for all clients that you sign up:

POST /integration/v1/user

Sample Request

 
{
    "nucleus_client_id": "<nucleus_client_id>",
    "product": "atom",
    "integration_type": "aggregation",
    "vendor_name": "saltedge"
}

Salt Edge requires an email address for the user. We will pull this from the email stored for the client_id in Nucleus. If you are not storing the email then you must add the following to the request above:

"vendor_request":{"email_id":"<email>"}

Widget Link

Call the following Hydrogen service to get the widget URL for the client:

GET /integration/v1/widget_link/{nucleus_client_id}?vendor_name=saltedge

Sample Response

 
{
    "widget_url": "https://www.saltedge.com/connect?token=2406cc17544e9df139907737a45dd011bcecfee37aebdd6bc14c1bbf1ddced3d",
    "vendor_name": "saltedge"
}
 

Copy the widget_url from the response and use as a web URL in the browser to have the user complete the authentication and connect their accounts.

Account Aggregation

Now we just have to create the aggregation account to store all the data in Nucleus from the response above.

POST /integration/v1/aggregation/account

  
{
     "nucleus_client_id": "<nucleus_client_id>",
     "product": "atom" 
} 
 

Once the account is stored, you can pull balances and transactions for the account (investment holdings coming soon).

GET /integration/v1/aggregation/balance/{aggregation_account_id}

GET /integration/v1/aggregation/transaction/{aggregation_account_id}


*Salt Edge is a technology integration on the Hydrogen platform. There is no implied partnership or company affiliation unless otherwise stated.

By using this site, you agree to our use of cookies, and you acknowledge that you have read and understand ourĀ Privacy Policy and Terms of Use   Continue