Skip to main content

PaymentRuleActionInput

Action applied when a rule's conditions match. type selects which other fields are required (see PaymentRuleActionType).

input PaymentRuleActionInput {
  type: PaymentRuleActionType!
  category: PaymentRuleCategory!
  paymentProcessorId: ID
  providerId: ID
  storeId: ID
  pointOfSaleId: ID
  splits: [PaymentRuleRouteSplitInput!]
  paymentMethods: [PaymentMethods!]
  offer: Boolean
}

Fields​

PaymentRuleActionInput.type ● PaymentRuleActionType! non-null enum​

What to do when the rule matches.

PaymentRuleActionInput.category ● PaymentRuleCategory! non-null enum​

Grouping the action belongs to. Must be consistent with type (see PaymentRuleCategory).

PaymentRuleActionInput.paymentProcessorId ● ID scalar​

Target payment processor: monei for MONEI, or the ID of a processor the merchant holds a contract with. monei covers every payment method MONEI takes; to target one payment method, add a payment method condition. monei:<paymentMethod> is not accepted. A deleted processor, one without its required credentials, or one of the other mode (live or test) is refused. Required when type is route_to or block_provider.

PaymentRuleActionInput.providerId ● ID scalar​

**Deprecated.** Use paymentProcessorId. When both are set, they must be equal.

PaymentRuleActionInput.storeId ● ID scalar​

ID of the store to tag on the payment, when the payment has no store yet. Required when type is tag_store.

PaymentRuleActionInput.pointOfSaleId ● ID scalar​

ID of the point of sale to tag on the payment, when the payment has no point of sale yet. Required when type is tag_pos.

PaymentRuleActionInput.splits ● [PaymentRuleRouteSplitInput!] list input​

Traffic shares for a split action. Required when type is route_split (with paymentProcessorId), tag_store_split (with storeId), or tag_pos_split (with pointOfSaleId); percentages must sum to 100.

PaymentRuleActionInput.paymentMethods ● [PaymentMethods!] list enum​

Payment methods to hide at checkout. Required when type is hide.

PaymentRuleActionInput.offer ● Boolean scalar​

Whether MONEI Flex installments are offered on the matching payments. Required when type is installments.

Member Of​

CreatePaymentRuleInput input ● UpdatePaymentRuleInput input

Last updated on