Invsy docs

Appearance

Data ​

Get all user context ​

Returns client data stored in state

js
invsy.data.getAllUserContext().then(res => {
    return res.result;
})
invsy.data.getAllUserContext().then(res => {
    return res.result;
})

Get user unique identifier ​

Returns a unique identifier of the current user

js
invsy.data.getUserUID().then(res => {
  return res.result
})
invsy.data.getUserUID().then(res => {
  return res.result
})

Get basic client details (name,surname,email,mobile number) ​

Returns a unique identifier of the current user

js
invsy.data.getClientBasicDetails().then(res => {
  return res.result
})
invsy.data.getClientBasicDetails().then(res => {
  return res.result
})

Get client personal features ​

Returns a list of personal features for the logged in user

js
invsy.data.getPersonalFeatures().then(res => {
   return res.result
})
invsy.data.getPersonalFeatures().then(res => {
   return res.result
})

Get personalisation offers ​

Returns personalisation cards and injects them into a specified div element

html
<div id="myId"></div>
<div id="myId"></div>
ts
invsy.data.getPersonalisationOffers(id:string,template:'offeringCard',data:Array<dataInterface>)

dataInterface {
  productSegment: string,
  subSegment: string,
  badgeColor: string,
  title: string,
  description: string,
  refImage: string,
  buttonText: string,
  showCard: boolean,
  route: string
}
invsy.data.getPersonalisationOffers(id:string,template:'offeringCard',data:Array<dataInterface>)

dataInterface {
  productSegment: string,
  subSegment: string,
  badgeColor: string,
  title: string,
  description: string,
  refImage: string,
  buttonText: string,
  showCard: boolean,
  route: string
}

Client Types ​

Returns client type properties

js
invsy.data.getClientTypes().then(res => {
    return res.result;
})
invsy.data.getClientTypes().then(res => {
    return res.result;
})
ts
PlatformClientTypes {
  private_bank_za: boolean,
    private_bank_uk: boolean,
    private_bank_mu: boolean,
    wealth_and_investment_za: boolean,
    wealth_and_investment_uk: boolean,
    business_banking_za: boolean,
    programmable_banking_za: boolean
}
PlatformClientTypes {
  private_bank_za: boolean,
    private_bank_uk: boolean,
    private_bank_mu: boolean,
    wealth_and_investment_za: boolean,
    wealth_and_investment_uk: boolean,
    business_banking_za: boolean,
    programmable_banking_za: boolean
}

My tip

Each flag indicates which API would work when a user enters your App.

PropertySDK
private_bank_zainvsy.api.privateClient.pbsa..
private_bank_ukinvsy.api.privateClient.pbuk..
private_bank_muinvsy.api.privateClient.pbmu..
wealth_and_investment_zainvsy.api.privateClient.wisa..
wealth_and_investment_ukinvsy.api.privateClient.wiuk..
business_banking_zainvsy.api.privateClient.bb..
programmable_banking_zainvsy.api.privateClient.programmable..

Get selected profile ​

Returns the current selected profile. It's an observable thus you can always subscribe for changes

js
invsy.data.getSelectedProfile().subscribe(res => {
    return res.result;
})
invsy.data.getSelectedProfile().subscribe(res => {
    return res.result;
})

Portfolio ​

Get state ​

Returns the current state of all portfolios in state

js
invsy.data.getState().then(res => {
    return res.result;
})
invsy.data.getState().then(res => {
    return res.result;
})

Exclude from total ​

Exclude specific portfolios from the overall total

ts
invsy.data.excludeFromTotal(payload?:{flag:string,result:boolean}[]).then(res => {
    return res.result;
})
invsy.data.excludeFromTotal(payload?:{flag:string,result:boolean}[]).then(res => {
    return res.result;
})

Get all portfolios ​

Get all the portfolios for the logged in client

js
invsy.data.getAllPortfolios(currency:string,selectedProfile:any).subscribe(res => {
    return res.result;
})
invsy.data.getAllPortfolios(currency:string,selectedProfile:any).subscribe(res => {
    return res.result;
})

Get specific portfolio ​

Get specific portfolio for the logged in client

ts
invsy.data.getPrivateBankZAPortfolio(currency:string,selectedProfile:any).then(res => {
    return res.result;
});

invsy.data.getPrivateBankUKPortfolio(currency:string).then(res => {
    return res.result;
});

invsy.data.getPrivateBankUKMortgagesPortfolio(currency:string).then(res => {
    return res.result;
});

invsy.data.getPrivateBankCIPortfolio(currency:string).then(res => {
    return res.result;
});

invsy.data.getPrivateBankMUPortfolio(currency:string).then(res => {
    return res.result;
});

invsy.data.getWealthAndInvestmentZAPortfolio(currency:string).then(res => {
    return res.result;
});

invsy.data.getWealthAndInvestmentUKPortfolio(currency:string).then(res => {
    return res.result;
});

invsy.data.getWealthAndInvestmentGUPortfolio(currency:string).then(res => {
    return res.result;
});

invsy.data.getWealthAndInvestmentClickPortfolio(currency:string).then(res => {
    return res.result;
});

invsy.data.getWealthAndInvestmentCIPortfolio(currency:string).then(res => {
    return res.result;
});

invsy.data.getAllNonInvestecAccounts(currency:string).then(res => {
    return res.result;
})
invsy.data.getPrivateBankZAPortfolio(currency:string,selectedProfile:any).then(res => {
    return res.result;
});

invsy.data.getPrivateBankUKPortfolio(currency:string).then(res => {
    return res.result;
});

invsy.data.getPrivateBankUKMortgagesPortfolio(currency:string).then(res => {
    return res.result;
});

invsy.data.getPrivateBankCIPortfolio(currency:string).then(res => {
    return res.result;
});

invsy.data.getPrivateBankMUPortfolio(currency:string).then(res => {
    return res.result;
});

invsy.data.getWealthAndInvestmentZAPortfolio(currency:string).then(res => {
    return res.result;
});

invsy.data.getWealthAndInvestmentUKPortfolio(currency:string).then(res => {
    return res.result;
});

invsy.data.getWealthAndInvestmentGUPortfolio(currency:string).then(res => {
    return res.result;
});

invsy.data.getWealthAndInvestmentClickPortfolio(currency:string).then(res => {
    return res.result;
});

invsy.data.getWealthAndInvestmentCIPortfolio(currency:string).then(res => {
    return res.result;
});

invsy.data.getAllNonInvestecAccounts(currency:string).then(res => {
    return res.result;
})

Lookups ​

Returns a list of SA Banks

js
invsy.data.lookups.bank.sa.list().then(res => {
        return res.result
})
invsy.data.lookups.bank.sa.list().then(res => {
        return res.result
})
ts
Bank {
  bank_id: string,
  bank_name: string,
  rtc_bank_id: string,
  bank_order: number,
  branch_list: Branch[]
}

Branch {
  branch_id: string,
  branch_name: string,
  is_cma_branch: boolean,
  branch_order: number
}
Bank {
  bank_id: string,
  bank_name: string,
  rtc_bank_id: string,
  bank_order: number,
  branch_list: Branch[]
}

Branch {
  branch_id: string,
  branch_name: string,
  is_cma_branch: boolean,
  branch_order: number
}

Returns a list of SA client lookups

js
invsy.data.lookups.client.sa.list().then(res => {
        return res.result
})
invsy.data.lookups.client.sa.list().then(res => {
        return res.result
})