API Reference

Create a new AMM rule for an account

post
https://example.com/programs//accounts//ammRule

Adds a new Auto Money Movement (AMM) rule to the specified account. Once applied, money can be automatically moved based on the rule parameters.

Path Params
string
required

The program code identifying the BaaS program context.

string
required

The unique identifier for the account to which the rule will be applied.

Body Params

The request payload containing AMM rule details.

string
required
length ≥ 1

The type of rule to create (e.g., "RoundUp", "ScheduledTransfer").

string
required
length ≥ 1

The frequency type of the rule (e.g., "Daily", "Weekly", "Monthly").

string | null

The name assigned to the AMM rule.

date-time
required

The start date when the rule becomes active.

date-time

The end date when the rule expires or is deactivated.

double
required

The qualifying amount required to trigger the rule.

double

The maximum cap amount for transfers under this rule.

uuid

The target purse identifier for the transfer.

uuid

The target account identifier for the transfer.

string | null

The contact name associated with the rule or transfer.

string | null

The handle (e.g., email, phone) of the transfer target.

string
required
length ≥ 1

The type of handle used for the transfer (e.g., "Email", "Phone").

int32

The priority of the rule for execution order.

category
array of int32s | null

The list of merchant category codes associated with the rule.

category
double

The fixed transfer amount for each execution of the rule.

double

The percentage of the qualifying amount to transfer.

boolean

Indicates whether the transfer is a round-up type.

int32

The scheduled day for rule execution (e.g., day of month).

string | null

Additional notes or comments about the rule.

string | null

The transfer type for the rule (e.g., "Purse", "PeerToPeer", "SccPayment").

string | null

The payment amount option for the rule (e.g., "Full", "Partial").

string | null

The source option for the rule (e.g., "Checking", "Savings").

int32 | null

The timezone offset for rule execution, if applicable.

boolean

Indicates whether this request is for editing an existing rule.

int64 | null

The previous rule ID, used when editing or replacing an existing rule.

Headers
string
required

A unique request identifier for tracking and logging. Should be a GUID.

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

401

Unauthorized

Updated 2 months ago

Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/json
text/json

Updated 2 months ago