# PaymentRule

Merchant-defined rule evaluated per transaction. When `conditions` match, `action` is applied (e.g. route the transaction to a provider, hide a payment method at checkout, or decline).

```
type PaymentRule {

  id: ID!

  accountId: ID!

  name: String

  priority: Int!

  enabled: Boolean!

  conditions: AWSJSON!

  action: AWSJSON!

  createdAt: AWSTimestamp!

  updatedAt: AWSTimestamp

}
```

### Fields[​](#fields "Direct link to Fields")

#### [`PaymentRule.id`](#id) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#id "Direct link to id")

Rule ID.

#### [`PaymentRule.accountId`](#account-id) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#account-id "Direct link to account-id")

Account that owns the rule.

#### [`PaymentRule.name`](#name) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#name "Direct link to name")

Human-readable label. Optional.

#### [`PaymentRule.priority`](#priority) ● [`Int!`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) non-null scalar[​](#priority "Direct link to priority")

Evaluation order. Lower values are evaluated first.

#### [`PaymentRule.enabled`](#enabled) ● [`Boolean!`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) non-null scalar[​](#enabled "Direct link to enabled")

Whether the rule is evaluated. Disabled rules are skipped.

#### [`PaymentRule.conditions`](#conditions) ● [`AWSJSON!`](https://docs.monei.com/apis/graphql/types/scalars/awsjson/.md) non-null scalar[​](#conditions "Direct link to conditions")

JsonLogic expression evaluated against the transaction context. Returned as a JSON-encoded string.

#### [`PaymentRule.action`](#action) ● [`AWSJSON!`](https://docs.monei.com/apis/graphql/types/scalars/awsjson/.md) non-null scalar[​](#action "Direct link to action")

Action applied when `conditions` match. Shape mirrors `PaymentRuleActionInput`; which fields are populated depends on `action.type`. Returned as a JSON-encoded string.

#### [`PaymentRule.createdAt`](#created-at) ● [`AWSTimestamp!`](https://docs.monei.com/apis/graphql/types/scalars/awstimestamp/.md) non-null scalar[​](#created-at "Direct link to created-at")

Creation timestamp (Unix seconds).

#### [`PaymentRule.updatedAt`](#updated-at) ● [`AWSTimestamp`](https://docs.monei.com/apis/graphql/types/scalars/awstimestamp/.md) scalar[​](#updated-at "Direct link to updated-at")

Last-update timestamp (Unix seconds); absent if the rule has never been updated.

### Returned By[​](#returned-by "Direct link to Returned By")

[`createPaymentRule`](https://docs.monei.com/apis/graphql/operations/mutations/create-payment-rule/.md) mutation ● [`paymentRule`](https://docs.monei.com/apis/graphql/operations/queries/payment-rule/.md) query ● [`updatePaymentRule`](https://docs.monei.com/apis/graphql/operations/mutations/update-payment-rule/.md) mutation

### Member Of[​](#member-of "Direct link to Member Of")

[`PaymentRulesConnection`](https://docs.monei.com/apis/graphql/types/objects/payment-rules-connection/.md) object