Create a fee for a specified customer account

Create a fee for the given customerId and accountId. Results in a new transaction retrievable via the /transaction/* endpoints.

📘

Note: This endpoint is intended for manual or Helix-initiated fee assessment. Not all fee types are eligible. The fee type must be configured and allowed for the account’s product and program.

Error Codes

Click to expand
CodeMessage (en-US)Notes
1-60000Any "Common Error Code" may occur.See Common Error Codes
61400Program is not authorized to use this endpoint. Please contact your relationship manager for details.
197100Helix fee engine workflow must have only 1 rule defined at root level
197101Exception is logged for a success rule result
197116There is no active fee {feeTypeId} for product type {productTypeId} configured for program {programId}
197117Fee type {feeTypeId} is invalid
197118Fee type is not part of fee engine framework
197119Fee rule definition id is invalid
197120Missing required parameter 'accountId'. Please refer to FeeEngine documentation for required parameters.
197121Missing required parameter 'customerId'. Please refer to FeeEngine documentation for required parameters.
197123Missing required parameter 'feetypeId'. Please refer to FeeEngine documentation for required parameters.
197125Missing required parameter 'feeAmount'. Please refer to FeeEngine documentation for required parameters. (only applicable for custom fees)
197127CustomerId '{customerId}' is not associated with AccountId '{accountId}.
197128Invalid account status.
197129Invalid customer status.
197131An existing FeeToApply record is found with the same tag
197134Required fee engine transaction input param is not valid
197139Fee Amount exceeds available balance
197140Error validating account balance to assess fee
197141FeeTypeId is not one of the allowed fee to be created manually from Helix
Body Params
int32
required
≥ 1
int32
required
≥ 1
int64
required
≥ 1
int64
required
≥ 1
Responses

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json