Step 1 - Create Job to retrieve Balance data

Overview

If you are balance information for the first time, or if you want to ensure that you have the most up-to-date information from the financial institution, you will need to create an balance refresh job.

Create Balance Refresh Job

HTTP Request

Staging - POST https://api.staging.aerosync.com/v2/accounts/{{user_id}}/balance-refresh

Production - POST https://api.aerosync.com/v2/accounts/{{user_id}}/balance-refresh

Request Parameters

ParameterRequired?TypeDescription
user_idYesStringA user's account unique identifier

Request and Response

GET https://api.staging.aerosync.com/v2/accounts/{{user_id}}/balance-refresh
Authorization: Bearer {{token}}

{
    "status": "success",
    "statusCode": 200,
    "identityStatus": "Initiated",
    "jobId": "IDT-ff1d12fc6dfa4b34ac9df85e676c30c0",
    "userId": "8cf406e45b2442e2b1ef491a5ce4cd0d"
}