Transactional Policy

Update a policy rule

put/api/v1/organizations/{organizationId}/policy/rules/{ruleId}

Request

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

Path parameters

organizationIdstring required
ruleIdstring required

Headers

x-mfa-tokenstring required

Request body

descriptionstring

Human-readable description of the rule

principalMatchstring

User ID or "*" for any principal

merchantMatchstring

Merchant ID or "*" for any merchant

originMatchstring

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

destinationMatchstring

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

operationTypeMatchstring

PolicyOperationType value or "*" for any operation

minAmountUsdnumber

Minimum transaction amount in USD

minDailyAmountUsdnumber

Minimum daily cumulative amount in USD

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

Action to take when rule matches

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

Approval mode

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.