Sign in
Rules

Update an existing rule.

<b>Authorization</b>: End user or Merchant token is required.

<b>User permissions required</b>: CanEditRules

put/api/v1/rules/{id}

Request

  • Base URL: https://api.nofrixion.com
  • URL: https://api.nofrixion.com/api/v1/rules/{id}
  • Auth: API key in header Authorization

Path parameters

idstring uuid required

The ID of the rule to update.

Request body

accountIDstring uuid nullable

Account ID the rule is associated with.

namestring nullable

A name to succinctly describe the rule.

descriptionstring nullable

Arbitrary description for the rule.

onApprovedWebHookUrlstring nullable

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.

onExecutionErrorWebHookUrlstring nullable

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

onExecutionSuccessWebHookUrlstring nullable

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

isDisabledboolean nullable

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

triggerOnPayInboolean nullable

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

triggerCronExpressionstring nullable

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

timeZoneIdstring nullable

If the rule should be executed on a recurring schedule this is the timezone

startAtstring date-time nullable

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

endAtstring date-time nullable

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

webHookSecretstring nullable

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

Response

The updated rule.

idstring uuid
accountIDstring uuid
merchantIDstring uuid

The ID of the merchant that owns the account.

userIDstring uuid nullable
approverIDstring uuid nullable
namestring nullable
descriptionstring nullable
isDisabledboolean
status'PendingApproval' | 'Active' | 'Disabled' | 'Failed'
triggerOnPayInboolean
triggerCronExpressionstring nullable
timeZoneIdstring nullable
startAtstring date-time nullable
endAtstring date-time nullable
approveUrlstring nullable

If set this property holds the URL an approver needs to visit in order to complete a strong authentication check in order to approve the rule.

onApprovedWebHookUrlstring nullable

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.

onExecutionErrorWebHookUrlstring nullable

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

onExecutionSuccessWebHookUrlstring nullable

Optional URL to receive an HTTP request when a rule execution attempt succeeds. The webhook payload will contain a list of any payouts that were submitted for the rule execution.

webHookSecretstring nullable

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

insertedstring date-time
lastUpdatedstring date-time
lastExecutedAtstring date-time nullable
lastRunAtTransactionDatestring date-time

The most recent transaction date when the rule was last run.

authorisersRequiredCountinteger

The number of authorisers required for this rule.

authorisersCompletedCountinteger

The number of distinct authorisers that have authorised the rule.

canAuthoriseboolean

True if the rule can be authorised by the user who loaded it.

hasCurrentUserAuthorisedboolean

True if the current user has authorised.

noncestring nullable required
authenticationMethodsstring[] nullable

A list of authentication types allowed to authorise the payout.

Changes

No recorded changes to this endpoint across all 2 revisions of this API.