PaymentRuleActionType

Action applied when a payment rule's conditions match. The selected type determines which other fields on the action are populated.

route_to - Route the transaction to a single provider. Requires providerId.
route_split - Split traffic across providers by percentage. Requires splits; percentages must sum to 100.
decline - Decline the transaction. No other fields required.
hide - Hide one or more payment methods at checkout. Requires paymentMethods.
block_provider - Remove a provider from the candidate pool for the matching transaction. Requires providerId.
force_challenge - Force a 3DS challenge for matching card transactions. No additional fields required. [AUTHENTICATION]
skip_challenge - Skip the 3DS challenge for matching card transactions (SCA exemption). No additional fields required. [AUTHENTICATION]
trigger_fraud_check - Run fraud detection for matching transactions, overriding the account-level fraud detector setting. No additional fields required. [FRAUD_DETECTION]
tag_store - Tag the operation with a store (set-if-absent). Requires storeId. [OPERATION_TAGGING]
tag_pos - Tag the operation with a point of sale (set-if-absent). Requires pointOfSaleId. [OPERATION_TAGGING]
tag_store_split - Tag the operation with a store chosen by percentage split. Requires splits (with storeId); percentages must sum to 100. [OPERATION_TAGGING]
tag_pos_split - Tag the operation with a point of sale chosen by percentage split. Requires splits (with pointOfSaleId); percentages must sum to 100. [OPERATION_TAGGING]

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
}