Create a Rule

post https://api-sandbox.modulrfinance.com/api-sandbox-token/rules

When you want a new rule on an account you can create one with this endpoint. Note that Rules are linked to an Account and each Account can only have one instance of a Rule type

time	status	user agent
Retrieving recent requests…

Loading…

Responses

Response body

object

string

required

Unique identifier for a Rule

type

string

required

The type of Rule. Can be one of the following {SWEEP, SPLIT, FUNDING}

SPLIT SWEEP FUNDING

status

string

ACTIVE INACTIVE

name

string

required

Rule's name

accountId

string

required

The Account which the Rule is created on.

accountCurrency

string

required

GBP EUR AED AFN ALL AMD ANG AOA ARS AUD AWG AZN BAM BBD BDT BGN BHD BIF BMD BND BOB BOV BRL BSD BTN BWP BYN BZD CAD CDF CHE CHF CHW CLF CLP CNY COP COU CRC CUC CUP CVE CZK DJF DKK DOP DZD EGP ERN ETB FJD FKP GEL GHS GIP GMD GNF GTQ GYD HKD HNL HRK HTG HUF IDR ILS INR IQD IRR ISK JMD JOD JPY KES KGS KHR KMF KPW KRW KWD KYD KZT LAK LBP LKR LRD LSL LYD MAD MDL MGA MKD MMK MNT MOP MRU MUR MVR MWK MXN MXV MYR MZN NAD NGN NIO NOK NPR NZD OMR PAB PEN PGK PHP PKR PLN PYG QAR RON RSD RUB RWF SAR SBD SCR SDG SEK SGD SLE SLL SOS SRD SSP STN SVC SYP SZL SHP THB TJS TMT TND TOP TRY TTD TWD TZS UAH UGX USD USN UYI UYU UYW UZS VES VND VUV WST XAF XAG XAU XBA XBB XBC XBD XCD XDR XOF XPD XPF XPT XSU XTS XUA XXX YER ZAR ZMW ZWL

masterId

string

required

The master rule ID. When a rule is changed, the original is marked as inactive, and a new one created. The master ID enables us to identify those rules which are updates

data

object

required

Configuration fields for all types of rules. To be populated where applicable based on rule type.

daysToRun

array of strings

Day(s) of the week the rule is to run. e.g. ["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"]. Sweep Rule Only

daysToRun

frequency

string

Frequency of the rule. Sweep Rule Only

Daily

destinationId

string

Id of destination beneficiary. e.g. B1000001. Sweep Rule Only

balanceToLeave

number

Balance to be left after the rule has been ran. e.g. 100.00. Sweep Rule Only

triggerBalance

number

Minimum balance required to trigger the rule. e.g. 100.00. Sweep Rule Only

splits

array of objects

splits

object

destinationId

string

required

Id of destination beneficiary. e.g. B1000001.

percent

string

required

Percentage of payment to be moved to specified destination. e.g. 7.25.

conditionalSplits

array of objects

conditionalSplits

object

destinationId

string

required

Id of destination beneficiary. e.g. B1000001.

percent

string

required

Percentage of payment to be moved to specified destination. e.g. 7.25.

conditionalSplitConfig

object

Configuration for a Conditional Split Rule

sourceId

string

Account to fund the supplied accountId. e.g. A1000002. Funding Rule Only

Language

Credentials

Header


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api-sandbox.modulrfinance.com/api-sandbox-token/rules \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '{"type":"SPLIT"}'

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

application/json

*/*

201Created

400Validation errors