GRgreendot
AMMRule

Create a new AMM rule for an account

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

post/programs/{programCode}/accounts/{accountIdentifier}/ammRule

Request

  • The document declares no server URL.
  • Auth
    API key in header Authorization

Path parameters

programCodestring required

The program code identifying the BaaS program context.

accountIdentifierstring required

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

Headers

X-GD-RequestIdstring required

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

Request body

ruleTypestring required

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

ruleFrequencystring required

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

ammRuleNamestring nullable

The name assigned to the AMM rule.

startDatestring date-time required

The start date when the rule becomes active.

endDatestring date-time

The end date when the rule expires or is deactivated.

qualifyAmountnumber double required

The qualifying amount required to trigger the rule.

maxCapAmountnumber double

The maximum cap amount for transfers under this rule.

targetPurseIDstring uuid

The target purse identifier for the transfer.

targetAccountIDstring uuid

The target account identifier for the transfer.

contactNamestring nullable

The contact name associated with the rule or transfer.

targetHandlestring nullable

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

handleTypestring required

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

rulePriorityinteger

The priority of the rule for execution order.

categoryinteger[] nullable

The list of merchant category codes associated with the rule.

fixedTransferAmountnumber double

The fixed transfer amount for each execution of the rule.

transferPercentagenumber double

The percentage of the qualifying amount to transfer.

isRoundUpTransferboolean

Indicates whether the transfer is a round-up type.

scheduleDayinteger

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

notestring nullable

Additional notes or comments about the rule.

transferTypestring nullable

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

paymentAmountOptionstring nullable

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

sourceOptionstring nullable

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

timezoneOffsetinteger nullable

The timezone offset for rule execution, if applicable.

isEditboolean

Indicates whether this request is for editing an existing rule.

preRuleIDinteger nullable

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

Response

Created

ruleEnrollmentKeyinteger

The unique enrollment key assigned to the newly created AMM rule. Used to reference and manage the rule in subsequent operations.

Changes

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