API Third-Party Investment Management (3PIM)
API Third-Party Investment Management (3PIM)
API Overview
Overview
Third-party investment management (3PIM) is a system that enables financial advisors to invest their clients' money into a range of investment accounts.
The system provides a platform for managing and tracking investments, as well as providing tools for making informed decisions. By using 3PIM, advisors can create and manage investment portfolios for their clients.
Description
This service allows you to:
- Request a payment to and from 3PIM accounts.
- Receive the status of a 3PIM Payment instruction sent to the bank.
API Scope
What is the API scope?
The API is currently available to certain customer groups, countries and covers a specific list of product accounts.
In-scope customer groups: This API is available for business, commercial, corporate and investment customers in the below countries.
In-scope countries: For customer groups in-scope who have a First National Bank account in South Africa, Botswana, Namibia, Zambia, Lesotho, eSwatini and Ghana.
Applicable product accounts: The API works for all business, corporate and investment product accounts such as transact, credit, invest, forex, loans and savings accounts.
Getting Started
Overview
OpenAPI Specification (OAS) is an industry standard programming language-agnostic specification standard for RESTful APIs. OAS allows easy access to discover and understand the API without having access to the source code, documentation or implementation logic. OAS is also widely known as Swagger specification.
How to get the API
You need to be an Online Banking Enterprise ™ user or complete the platform registration.
There are a few ways in which you can get the API.
- Unassisted: With unassisted, you can subscribe to the transaction history: customer accounts API on Integration Channel, which is found under Business Solutions tab on Online Banking Enterprise ™.
- Assisted: You can contact your Digital Profile Manager, Transactional Portfolio Manager or Implementation Manager who can assist in connecting you to the API.
How to connect to the API
The client can connect and consume the API in two ways:
1 On my own behalf
You can connect to the API directly from your line of business system. This can be achieved without a technology intermediary or third-party (System Operator or Third-Party Payment Provider).
With this connection type, you are required to select accounts you would like to use for the API when you subscribe. The selected accounts will also be validated when you make the API call.
In both unassisted and assisted journeys, you can maintain your connection details to your line of business system.
2 Through a Third-Party
You delegate the API processing and connection responsibility to an intermediary or third-party (System Operator or Third-Party Payment Provider).
With this connection type, you will be required to provide the Bank with consent to share your product account information with the third-party as well as indicate which accounts the third-party can retrieve information on. Consent will be provided through the Auth code flow as described on the Authorisation section of this document.
In both unassisted and assisted journeys, you can maintain or revoke the consent for the third-party to act on your behalf as well as the selection of the accounts.
Available Transports
Rest API
RESTful API represents API call received through a RESTful service using the HTTP as a transport layer. RESTful API's are useful when broken down into simple method calls as it enables the simplified interaction with the Bank and the future development of the FirstRand API Economy.
API References
API reference
The API reference includes details on the structure of the API request and response formats. These are detailed on the Swagger document and message specification.
The message follows the ISO20022 message standard in JSON Format, using PAIN.008,PAIN.009,PAIN.010,PAIN.011,PAIN.012 for the response.