PaymentRuleActionType

What a payment rule does when its conditions match. type decides which other action fields are needed. The dashboard shows the rules on Settings > Payments orchestration.

route_to - Send the payment to one payment processor. Needs paymentProcessorId. Category CARD_ROUTING. Shown as Route to.
route_split - Share matching payments between payment processors by percentage. Needs splits; the percentages add up to 100. Category CARD_ROUTING. Shown as Split traffic.
decline - Decline the payment. Needs no other field. Category DENY. Shown as Decline.
hide - Hide payment methods at checkout. Needs paymentMethods. Category PAYMENT_METHOD_VISIBILITY. Shown as Hide payment methods.
block_provider - Remove a payment processor from the choices for the payment. Needs paymentProcessorId. Category PROVIDER_ELIGIBILITY. Shown as Block processor.
force_challenge - Ask for a 3DS challenge on matching card payments. Needs no other field. Category AUTHENTICATION. Shown as Force 3DS challenge.
skip_challenge - Ask for no 3DS challenge on matching card payments, where the processor supports it. Needs no other field. Category AUTHENTICATION. Shown as Skip 3DS challenge.
trigger_fraud_check - Run the fraud detector on matching payments, also when it is off for the account. Needs no other field. Category FRAUD_DETECTION. Shown as Trigger fraud check.
tag_store - Tag the payment with a store, when it has none. Needs storeId. Category OPERATION_TAGGING. Shown as Tag store.
tag_pos - Tag the payment with a point of sale, when it has none. Needs pointOfSaleId. Category OPERATION_TAGGING. Shown as Tag point of sale.
tag_store_split - Tag the payment with a store chosen by percentage. Needs splits with storeId; the percentages add up to 100. Category OPERATION_TAGGING. Shown as Split by store.
tag_pos_split - Tag the payment with a point of sale chosen by percentage. Needs splits with pointOfSaleId; the percentages add up to 100. Category OPERATION_TAGGING. Shown as Split by point of sale.
installments - Offer MONEI Flex installments on matching card payments, or do not offer them. MONEI Flex is offered by default where it is available. Needs offer. Category INSTALLMENTS. Shown as MONEI Flex.

enum PaymentRuleActionType {
  route_to
  route_split
  decline
  hide
  block_provider
  force_challenge
  skip_challenge
  trigger_fraud_check
  tag_store
  tag_pos
  tag_store_split
  tag_pos_split
  installments
}