Resolved Rulesets

string<uuid>

required

ID of Ruleset.

version

number

required

Ruleset version.

trigger

object

required

An action that determines when the rules should be evaluated.

Hide child attributes

trigger.on

enum<string>

required

Action name.

Available options:

determinePaymentOptions,

determineProviderOptions,

repeat

trigger.filter

Action `determinePaymentOptions` filter. · object

A map of fields from the execution context and their expected values, which allows to trigger rules evaluation when all context field values match the expected ones.

Action `determinePaymentOptions` filter.
Action `determineProviderOptions` filter.
Action `repeat` filter.

Hide child attributes

trigger.filter.paymentMethodCode

enum<string>

Code of the payment method selected to perform the payment.

Available options:

alexBankMa7fazty,

amazonPay,

applePay,

audi2pay,

alfa,

alipay,

bankTransfer,

card,

2c2p,

capitecPay,

cibSmartWallet,

easypaisa,

etisalatCash,

fawryMobileWallet,

fawryPay,

googlePay,

jazzCash,

mercadoPago,

monoDirectDebit,

nbePhoneCash,

orangeCash,

oPayWallet,

pagaWallet,

payflex,

payjustnow,

payPal,

pix,

konnect,

qnbEWallet,

wafaCashWallet,

weCash,

genericRedirect,

eftPro,

upi,

upiDirect,

cashFreeWallet,

paytmMWallet,

netBanking,

meezaWallet,

vodafoneCash,

alipayQRCode,

sepaDirectDebit,

sepaDirectDebitDirect,

dcb,

bankAccount,

modo,

ach,

payzoneCash,

revolutPay,

lean,

tabby,

boleto,

oxxo,

spei,

promptPay,

qris,

momoVN,

vietQR,

konbini,

touchNGo,

gCash,

maya,

pse,

pagoEfectivo,

napas,

duitNowQR,

grabPay,

shopeePay,

nequi,

picPay,

ovo,

trueMoney,

iDeal,

iDealDirect,

bancontact,

mbWay,

mbWayDirect,

khipu,

razerGold,

webPay,

smartPix,

venmo,

klarnaPayLater,

klarnaPayNow,

klarnaPayOverTime,

knet,

scalapay,

bizum,

payNow,

atome,

fpx,

swish,

bcp

defaultAction

Set capture mode. · object

required

Default action to execute if none of rule conditions are fulfilled.

Hide child attributes

defaultAction.type

enum<string>

required

Set the capture mode.

Available options:

setCaptureMode

defaultAction.params

object

required

Hide child attributes

defaultAction.params.mode

enum<string>

required

Capture mode to define if money is captured instantly, with delay or manually.

Available options:

Instant,

Delayed,

Manual

createdAt

string<date-time>

Creation date of the ruleset.

rules

Rule. · object[]

Rules what need to be evaluated to execute or an action defined by a rule, which condition is fulfilled, or default action if none of conditions are fulfilled.

Hide child attributes

rules.condition

Empty condition. · object

required

A condition that checks whether a field is empty.

Empty condition.
Simple condition.
Simple condition.
Combination of conditions.
Condition negation.

Hide child attributes

rules.condition.field

string

required

An execution context field name.

rules.condition.empty

boolean

required

Whether the field must be empty (true) or not empty (false).

rules.action

Set capture mode. · object

required

Action to execute if the rule condition is fulfilled.

Hide child attributes

rules.action.type

enum<string>

required

Set the capture mode.

Available options:

setCaptureMode

rules.action.params

object

required

Hide child attributes

rules.action.params.mode

enum<string>

required

Capture mode to define if money is captured instantly, with delay or manually.

Available options:

Instant,

Delayed,

Manual

Payrails API Reference

Get started

Workflow

Payment

Provider

Merchant

Vault

Analytics

Reporting

Reconciliation

Dispute