We collated a list of some of the most common questions community members are asking. We'll grow this list with your support
If you have a question that isn't covered by these FAQs, post it on the 💬
And if you find the solution to an error or a bug, write it down, post it in the or record a quick video. Chances are other developers are having the same issue, and you might save them a lot of time.
🖥️ Investec API FAQs
How do I create a new or multiple Investec API key(s)?
You can create API keys for your account by logging into the . Navigate to "Manage" -> “Investec Developer” -> "Individual Connections" to access your API credentials and create API key(s) for your Private Banking account.
Check out for more details.
How do I authenticate and obtain an access token to use the Investec Banking APIs?
The authentication process involves obtaining an access token using the OAuth 2.0 Authorisation Framework. You'll need to make a request to the authentication endpoint with your client credentials to receive the access token.
Check out for more details.
What are the main API endpoints and methods available for accessing account and transaction information?
The API provides several endpoints, such as "Get Accounts," "Get Account Balance," and "Get Account Transactions," which allow you to retrieve account details, balances, and transaction information. These endpoints support HTTP methods like GET and POST.
Check out for more details.
How do I obtain a list of accounts associated with a profile?
You can use the "Get Accounts" endpoint (GET /za/pb/v1/accounts) to obtain a list of accounts associated with a profile. This endpoint requires the authorisation bearer token.
Check out for more details.
How do I retrieve the balance of a specific account?
You can use the "Get Account Balance" endpoint (GET /za/pb/v1/accounts/{accountId}/balance) to retrieve the balance of a specific account. Replace {accountId} with the actual account ID.
How do I fetch transactions for a specific account within a specified date range?
You can use the "Get Account Transactions" endpoint (GET /za/pb/v1/accounts/{accountId}/transactions) to fetch transactions for a specific account. You can provide optional query parameters such as fromDate, toDate, and transactionType to filter the transactions.
Why is the Posted Order of my transactions =0 ?
The Posted Order of a transaction may start out listed as 0 and then change to the correct number once it has settled. To be safe, ignore transactions while their Posted Order =0.
What is the difference between the fields transactionDate and postingDate?
transactionDate is the date that you swiped your card or issued a payment. postingDate is the date that the amount was deducted from your balance.
What are the main API endpoints and methods available for making account transfers and beneficiary payments?
Description: Enables you to pay funds to one or multiple beneficiaries.
RequestBody: The request body should include an array of payment objectives specifying the beneficiary, amount, and reference details. \
To initiate transfers and payments, make a HTTP POST request to the respective endpoints mentioned above. Ensure that you include the necessary authorisation and authentication headers, and the Bearer token obtained through the OAuth process, to authenticate your API request.
Can I create a beneficiary via the API?
Once you have created a beneficiary, make at least one payment to that beneficiary using Investec Online before initiating a payment via the API. This ensures that the beneficiary is properly set up and ready to receive payments via the API.
Is there a payment limit on the Beneficiary Payments API?
💳 Card FAQs
Where do I access the Online IDE to program my card?
How do I intercept and modify card transactions using custom code?
You can use the beforeTransaction method in the main.js file to intercept the authorization object before it is approved by Investec. Within this method, you can apply logic to either approve or decline the transaction based on the authorization data or external data sources.
Can I approve or decline a transaction based on specific conditions?
Yes, you can apply conditional logic within the beforeTransaction method to approve or decline a transaction based on specific criteria. For example, you can check the transaction amount, beneficiary details, or other factors to determine the appropriate action.
How do I perform actions or communicate with external resources after a transaction is completed?
You can use the afterTransaction method to perform actions or communicate with external resources after processing the transaction. For example, you could set up email notifications every time you swipe your card.
Are there any limitations or time constraints on executing custom code for card transactions?
The beforeTransaction method has a limited window of 2 seconds to execute, so it's important to ensure your code is efficient and responds within that timeframe. However, the afterTransaction method provides a larger window of 15 seconds for post-transaction actions.
How do I securely manage and reference environment variables for my custom code on the card?
Environment variables can be defined and saved in the env.json file. These variables can then be accessed within the main.js file using process.env.variableName. This allows you to securely store and reference sensitive information or configuration details.
How do I differentiate between simulated transactions and production transactions?
You can differentiate between simulated transactions and production transactions by checking the transaction reference. In the afterTransaction method, you can compare transaction.reference with a specific value (e.g., "simulation") to identify simulated transactions.
Check out How to simulate a transaction for more details.
Check out for more details.
Check out for more details.
View the for more details.
Currently, the API does not support direct creation of beneficiaries. To create a beneficiary, use theor other standard methods provided by Investec.
No, limits are set up as per online banking. You must have made a payment to the beneficiary via before making a payment to a beneficiary via the API.
Check out for more details.
Login to the and navigate to Investec Developer. Navigate to the desired card on your profile and ensure that you have enabled it by toggling the button below the card. Click on the card to open up the Online IDE.
Check out for more details.
Check out for more details.
Check out for more details.
💡 It's always recommended to consult the provided by Investec for detailed instructions and specific technical guidance
