Set Settings for Profile

Updates configuration settings for a specific customer profile, including financial account limits and transfer amount restrictions.

Set Settings for Profile

This endpoint allows partners and administrators to update configuration settings for a specific customer profile. Settings include financial account permissions (maximum number of financial and external accounts) and transfer amount limits for ACH outbound and internal transfers. Successful execution returns a confirmation of the applied changes.

Endpoint

POST /netevia/profile/{profileId}/settings

Authentication

Bearer token required. Obtain via:

POST https://api.banking.netevia.dev/api/auth/v2

Include in header: Authorization: Bearer {token}
Token lifetime: 10 minutes. Refresh via POST /api/auth/refresh.

When to use

Use this endpoint when you need to configure or adjust operational limits for a specific customer profile, such as increasing the maximum number of financial accounts a customer can hold, capping the number of external linked accounts, or setting per-transfer dollar limits. This is typically called during onboarding to apply partner-defined constraints, or during account lifecycle events when limits need to be revised.

Path Parameters

ParameterTypeRequiredDescription
profileIdinteger (int32)YesThe unique numeric identifier of the customer profile whose settings are being updated.

Request Body

FieldTypeRequiredDescription
financialAccountsPermissionsobjectNoDefines maximum allowed counts for financial and external accounts.
financialAccountsPermissions.financialAccountsMaxNumberinteger (int32)NoMaximum number of financial accounts the profile may hold. Minimum: 1.
financialAccountsPermissions.externalAccountsMaxNumberinteger (int32)NoMaximum number of external accounts (e.g., Finicity/Plaid-linked) the profile may hold. Minimum: 1.
transferAmountLimitsobjectNoDefines per-transfer dollar amount caps for ACH and internal transfers.
transferAmountLimits.achOutTransferAmountLimitinteger (int64)NoMaximum dollar amount allowed per outbound ACH transfer. Nullable — omit or set to null for no limit.
transferAmountLimits.internalTransferAmountLimitinteger (int64)NoMaximum dollar amount allowed per internal transfer between accounts. Nullable — omit or set to null for no limit.
loanOffbooleanNoWhen set to true, disables loan/funding features for this profile.
{
  "financialAccountsPermissions": {
    "financialAccountsMaxNumber": 5,
    "externalAccountsMaxNumber": 3
  },
  "transferAmountLimits": {
    "achOutTransferAmountLimit": 10000,
    "internalTransferAmountLimit": 25000
  },
  "loanOff": false
}

Response

200 OK

A 200 response confirms the settings were successfully applied to the profile. The response body is empty on success.

{}

Error Codes

CodeWhen it happens
400Missing required fields or validation error (e.g., financialAccountsMaxNumber below minimum of 1)
401Token missing, expired, or invalid
403Insufficient permissions to update settings for the specified profile
404Profile with the given profileId does not exist
500Internal server error

Common Mistakes

  • Providing a financialAccountsMaxNumber or externalAccountsMaxNumber value less than 1 — both fields enforce a minimum of 1.
  • Setting achOutTransferAmountLimit or internalTransferAmountLimit to 0 instead of null when intending to remove a cap — use null to indicate no limit.
  • Sending an integer profileId as a string in the path — the parameter must be a numeric integer.
  • Omitting the Authorization header or using an expired token, which results in a 401 error.

Related Endpoints

  • POST /netevia/profile — Create a new customer profile
  • GET /netevia/profile/{profileId} — Retrieve profile details
  • POST /api/auth/v2 — Obtain authentication token
  • POST /api/auth/refresh — Refresh an expiring token

Example

curl -X POST https://api.banking.netevia.dev/netevia/profile/98765/settings \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "financialAccountsPermissions": {
      "financialAccountsMaxNumber": 5,
      "externalAccountsMaxNumber": 3
    },
    "transferAmountLimits": {
      "achOutTransferAmountLimit": 10000,
      "internalTransferAmountLimit": 25000
    },
    "loanOff": false
  }'
Path Params
int32
required
Body Params
financialAccountsPermissions
object
transferAmountLimits
object
boolean
Headers
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Response
200

Success

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here!