SSO GuideAPI Guide

API Rules

The API Rules feature allows clients to define rules in TrueACH that control which API requests will be processed and which will be ignored. This functionality helps prevent unnecessary queries and fees by validating API requests against configured rules before they are executed.

The feature is available In TrueACH under the Settings tab for clients who are enabled for API queries. It allows clients to create and customize rules by query type; Account Status Only, AOA Only, or Account Status + AOA. Available query types are based on the client’s API configuration. When a rule is established, all conditions must be met before a transaction within an API request is processed. API Rules configured for a client get applied to all integrations for that client and any validations made through the API by the client themselves.

If API Rules are configured and an API request does not meet all conditions of the established rules, then the ApiErrorMessage Json property will return Validation bypassed due to rule: and append the first rule. For example, say a client configures a rule for Amount greater than $100.00.

If an integrator calls the TrueACH API to validate a transaction for an Amount that is $10.00, then the validation will not run and apiErrorMessage": "Validation bypassed due to rule: Amount Equals To $100.00" will be returned in the Json response body.