Creates a new rule for a MoneyMoov payment account.

post

https://api-sandbox.nofrixion.com/api/v1/rules

Authorization: End user or Merchant token is required.

User permissions required: CanCreateRules

Body Params

The model of the new rule to create.

accountID

uuid

The ID of the account the rule will apply to.

name

string

required

length ≥ 1

A name to succinctly describe the rule.

description

string | null

Arbitrary description for the rule.

onApprovedWebHookUrl

string | null

Optional URL to receive an HTTP request with the rule details when the rule status changes to approved. The webhook payload will contain the full Rule object.

onExecutionErrorWebHookUrl

string | null

Optional URL to receive an HTTP request when a rule execution attempt fails. The webhook payload will contain a NoFrixionPorblem object.

onExecutionSuccessWebHookUrl

string | null

Optional URL to receive an HTTP request when a rule execution attempt succeeds. The webhook payload will contain a ?.

isDisabled

boolean

If set to true the rule will be disabled from executing.

triggerOnPayIn

boolean

Set to true if the rule execution should be triggered when the account receives a pay in (credit).

triggerCronExpression

string | null

If the rule should be executed on a recurring schedule this is the expression that sets the schedule. The expression uses a CRON format.

timeZoneId

string | null

If the rule should be executed on a recurring schedule this is the timezone that the CRON expression should be evaluated in. The default is UTC.

startAt

date-time | null

Optional start time for rule executions. If this value is set the rule will not be triggered until the start time has been reached.

endAt

date-time | null

Optional end time for rule executions. If this value is set the rule will not be triggered after the end time has been reached.

sweepAction

object

required

webHookSecret

string | null

If set this secret will be used to sign Web Hook requests.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

201

The newly created rule.

Language

Credentials

Header

Response

Click Try It! to start a request and see the response here! Or choose an example:

text/plain

application/json

text/json

200OK