API Secrets Management for Banking Integration in NetSuite

Manage API secrets for bank application credentials to securely connect your NetSuite system with banks, enhancing security and performance.

·2 min read·View Oracle Docs

When integrating payments with a bank through an API, the bank provides application credentials. To further safeguard these credentials, you must create API secrets within NetSuite. This includes:

  • An API secret to store the client ID credential.
  • An API secret to store the client secret credential.

Creating API Secrets

When creating the API secrets, it’s vital to note the IDs assigned to each secret. To create a secret in NetSuite:

  1. Navigate to Setup > Company > Preferences > API Secrets.
  2. Click Create New at the top of the page.
  3. In the Create New Secret window:
    • On the Details tab, enter a descriptive name for this secret in the Name field. Avoid using sensitive or private information, as this will be visible to other users.
    • Input a script ID for this secret in the ID field. This should be descriptive and should not contain spaces or special characters; NetSuite prefixes the script ID with 'custsecret'.
    • Enter the secret in the Password field, or load it from a file for multi-line secrets.
    • Confirm the password in the Confirm Password field.
    • Check the Expiration Warning box if you want an alert when the secret is nearing its expiration date (optional).
    • Provide a description in the Description field, avoiding sensitive information.

Associating API Secrets

Once the API secrets are created, they need to be associated with the bank connection record for each bank. If a bank has multiple connections, the same secrets can be used across all records for that bank.

Important Notes

  • You can securely store, manage, and reference API secrets in NetSuite to avoid using plaintext secrets in scripts.
  • API secrets can include hashes, passwords, keys, and other sensitive authentication credentials, with a maximum size of 1,000,000 characters.
  • It may take up to one hour for new passwords to update. The old credentials must remain functional during this period.

For further details about adding applications or settings specific to particular banks, consider checking the relevant documentation related to those specific integrations.


Frequently Asked Questions (4)

What are the prerequisites for setting up API secrets in NetSuite?
To set up API secrets, you need to have access to a bank-provided application credential, and the appropriate permissions to access the Setup and Company Preferences in NetSuite.
How should the script ID be formatted when creating a new API secret in NetSuite?
The script ID should be descriptive, contain no spaces or special characters, and NetSuite will automatically prefix it with 'custsecret'.
Can the same API secrets be used for multiple bank connections within NetSuite?
Yes, the same API secrets can be associated and used across multiple bank connection records for a single bank.
What happens if you need to change the API secret credentials in NetSuite?
It may take up to one hour for newly updated passwords to take effect. Old credentials must remain functional during this period to ensure continued connectivity.
Source: API Secrets for Bank Application Credentials Oracle NetSuite Help Center. This article was generated from official Oracle documentation and enriched with additional context and best practices.

Was this article helpful?

More in Banking

View all Banking articles →