Transactional Policy

Add a rule to the policy

post/api/v1/organizations/{organizationId}/policy/rules

Request

  • Base URL: https://api-sandbox.koywe.com
  • URL: https://api-sandbox.koywe.com/api/v1/organizations/{organizationId}/policy/rules
  • Auth: HTTP bearer

Path parameters

organizationIdstring required

Headers

x-mfa-tokenstring required

Request body

ruleOrdernumber required

Rule evaluation order (lower = higher priority)

descriptionstring

Human-readable description of the rule

principalMatchstring required

User ID or "*" for any principal

merchantMatchstring required

Merchant ID or "*" for any merchant

originMatchstring required

Account ID, currency symbol, or "*" for any origin

destinationMatchstring required

Account ID, currency symbol, or "*" for any destination

operationTypeMatchstring required

PolicyOperationType value or "*" for any operation

minAmountUsdnumber required

Minimum transaction amount in USD that activates this rule

minDailyAmountUsdnumber

Minimum daily cumulative amount in USD that activates this rule

action'ALLOW' | 'REQUIRE_APPROVAL' | 'DENY' required

Action to take when rule matches

approvalMode'ANY_OF' | 'ALL_OF' | 'THRESHOLD'

Approval mode (required when action = REQUIRE_APPROVAL)

approversstring[]

List of approver User IDs

approvalThresholdnumber

Required approval count for THRESHOLD mode

Response

status'APPLIED' | 'PENDING_APPROVAL' required
pendingApprovalIdstring

Changes

No recorded changes to this operation across all 1 revision of this API.