Skip to main content

PaymentRule

Conditional rule the merchant configures to control card routing or payment-method visibility. Rules are evaluated per transaction; when conditions match, action is applied.

type PaymentRule {
id: ID!
accountId: ID!
ruleType: PaymentRuleType!
conditions: PaymentConditions!
action: PaymentAction!
createdAt: AWSDateTime!
updatedAt: AWSDateTime
}

Fields

PaymentRule.id ● ID! non-null scalar

Rule ID.

PaymentRule.accountId ● ID! non-null scalar

Account that owns the rule.

PaymentRule.ruleType ● PaymentRuleType! non-null enum

What the rule controls (card routing / 3DS or payment-method visibility).

PaymentRule.conditions ● PaymentConditions! non-null object

Conditions that must be satisfied for action to apply.

PaymentRule.action ● PaymentAction! non-null object

Action to apply when conditions match.

PaymentRule.createdAt ● AWSDateTime! non-null scalar

Creation timestamp.

PaymentRule.updatedAt ● AWSDateTime scalar

Last-update timestamp.

Returned By

createPaymentRule mutation ● paymentRule query ● updatePaymentRule mutation

Member Of

PaymentRulesConnection object