Qodex.ai

EXT Upvest Investment API TOL

Number of APIs: 115

This collection was created by Upvest Developers Experience team for use by our integration partners.

Disclaimer:

This collection includes all possible API calls for the TOL operating model. If you are facing 403 errors, please check with your team if this feature should be enabled for your client. If this is the case, please contact the Upvest team to update your client configuration.

Prerequisites:

  • Install the httpsignature-proxy executable by running: brew tap upvestco/httpsignature-proxy; brew install httpsignature-proxy.

  • Add and edit a file ~/.httpsignature-proxy.yaml, please replace the {{UPPERCASE_PLACEHOLDERS}} with their respective values:

private-key: "{{PATH_AND_FILENAME_OF_PRIVATE_KEY_FILE}}"
private-key-password: "{{PASSWORD_FOR_PRIVATE_KEY_FILE}}"
server-base-url: "https://sandbox.upvest.co"
key-id: "{{KEY_ID_FOR_PRIVATE_KEY_ISSUED_BY_UPVEST}}"
port: 3000

  • Start the HTTP signature proxy with this command: httpsignature-proxy start

  • Place the ClientID and Client Secret provided to you by Upvest into the CURRENT VALUE column of the [collection variables] named clientID and clientSecret. Do not forget to save this Qodex Collection, or else the CURRENT VALUEs of these variables could get lost.

Authorization:

Before sending any request to the Investment API, you need to acquire an adequately scoped OAuth2 access token.

You can do that by clicking on the Get New Access Token button at the end of the Authorization tab of this collection.

After clicking Get New Access Token, please click also on Proceed and Use Token.

How to?

The collection consists of two sections: Getting Started and Advanced.
Please note that it is necessary to go through at least the Onboard User and Create Account calls of the Getting Started section first. This will ensure that you have a valid user with everything set up for further testing of a part from the Advanced section.

Contact Support:

Slack: type /upvest_help in our shared Slack channel

Email: api_support@upvest.co

Portal: https://support.upvest.co/

  1. Getting Started-Fund with Cash - Trigger funding payment POST {{proxiedPublicURL}}/payments/direct_debits

  2. Getting Started-Onboard User - Create a user POST {{proxiedPublicURL}}/users

  3. Getting Started-Onboard User - OPT/DIAG List all checks for a user GET {{proxiedPublicURL}}/users/{{latestUserID}}/checks

  4. Getting Started-Onboard User - OPT/DIAG Retrieve a user GET {{proxiedPublicURL}}/users/{{latestUserID}}

  5. Getting Started-Create Account - Create account group POST {{proxiedPublicURL}}/account_groups

  6. Getting Started-Create Account - Create PORTFOLIO account POST {{proxiedPublicURL}}/accounts

  7. Getting Started-Create Account - OPT/DIAG List user accounts GET {{proxiedPublicURL}}/users/{{latestUserID}}/accounts

  8. Getting Started-Fund with Cash - Create a mandate POST {{proxiedPublicURL}}/payments/mandates

  9. Getting Started-Fund with Cash - OPT/DIAG List mandates GET {{proxiedPublicURL}}/users/{{latestUserID}}/payments/mandates

  10. Getting Started-Fund with Cash - Retrieve cash balance GET {{proxiedPublicURL}}/account_groups/{{latestAccountGroupID}}/payments/cash_balance