openapi: 3.2.0 info: title: transaction-monitoring Rules API version: '1.0' servers: - url: https://sandbox-oxygen.fiatrepublic.com/api/v1 security: - sec0: [] tags: - name: Rules paths: /rules: post: summary: Create Rule description: '' operationId: oxygen-create-rule requestBody: content: application/json: schema: type: object properties: name: type: string description: Rule Name definition: type: object description: '[IMPORTANT] In one request you can create only one rule' properties: Activity on dormant account: type: object required: - template - cumulativeTimePeriod - cumulativeAmountThreshold - timePeriod properties: template: type: string enum: - ActivityOnDormantAccount cumulativeTimePeriod: type: string description: Specify period of transactions to monitor since the dormancy enum: - 4h - 8h - 12h - 1d - 2d - 7d - 14d - 30d - 45d - 60d - 90d cumulativeAmountThreshold: type: string description: Minimum threshold which should trigger the alert timePeriod: type: string description: Specify dormancy period enum: - 4h - 8h - 12h - 1d - 2d - 7d - 14d - 30d - 45d - 60d - 90d entityRisk: type: string description: Specify for which risk level you want to implement this rule, if for all you can leave this field empty enum: - LOW - MEDIUM - HIGH age: type: object properties: condition: type: string enum: - ABOVE - BELOW value: type: integer format: int32 entityType: type: string enum: - INDIVIDUAL - BUSINESS entityExternalTypes: type: array description: '["END_USER", "USER", "CLIENT"]' items: type: string Cumulative transaction amount: type: object required: - template - amountThreshold - timePeriod properties: template: type: string enum: - CumulativeTransactionAmount amountThreshold: type: string description: Threshold of the transaction which should trigger the alert (equal or more) timePeriod: type: string description: Specify time period for transactions enum: - 4h - 8h - 12h - 1d - 2d - 7d - 14d - 30d - 45d - 60d - 90d entityRisk: type: string description: Specify for which risk level you want to implement this rule, if for all you can leave this field empty enum: - LOW - MEDIUM - HIGH direction: type: string description: Payin or payout depending on which transaction should trigger the alert. If not provided rule will apply to both enum: - PAYIN - PAYOUT - '' age: type: object description: Relates to INDIVIDUAL entity type properties: condition: type: string enum: - ABOVE - BELOW value: type: integer format: int32 entityType: type: string enum: - INDIVIDUAL - BUSINESS entityExternalTypes: type: array description: '["END_USER", "USER", "CLIENT"]' items: type: string Fast in fast out: type: object required: - template - timePeriodDeposits - timePeriodWithdrawals - percentageThreshold properties: template: type: string enum: - FastInFastOut timePeriodDeposits: type: string description: Specify time period for deposits enum: - 4h - 8h - 12h - 1d - 2d - 7d - 14d - 30d - 45d - 60d - 90d timePeriodWithdrawals: type: string description: Specify time period for withdrawals enum: - 4h - 8h - 12h - 1d - 2d - 7d - 14d - 30d - 45d - 60d - 90d percentageThreshold: type: string description: Specify how many percent of the funds deposited should have been withdrawn in order for alert to be triggered amountThreshold: type: string description: Amount threshold in 2 decimal places. age: type: object properties: condition: type: string enum: - ABOVE - BELOW value: type: integer format: int32 entityType: type: string enum: - INDIVIDUAL - BUSINESS entityExternalTypes: type: array description: '["END_USER", "USER", "CLIENT"]' items: type: string High volumes on new entity: type: object required: - accountTimePeriod - cumulativeAmountThreshold properties: template: type: string enum: - HighVolumesOnNewEntity accountTimePeriod: type: string description: Time since the entity has been created enum: - 4h - 8h - 12h - 1d - 2d - 7d - 14d - 30d - 45d - 60d - 90d cumulativeAmountThreshold: type: string description: 'Minimum threshold which should trigger the alert. Ex: 80.0' direction: type: string description: Payin or payout depending on which transaction should trigger the alert. If not provided rule will apply to both enum: - PAYIN - PAYOUT - '' age: type: object properties: condition: type: string enum: - ABOVE - BELOW value: type: integer format: int32 dateToConsider: type: string description: Date of creation in Member's system (EXTERNAL_CREATED_AT) or date of creation on Fiat Republic platform (CREATED_AT) enum: - EXTERNAL_CREATED_AT - CREATED_AT entityType: type: string enum: - INDIVIDUAL - BUSINESS entityExternalTypes: type: array description: '["END_USER", "USER", "CLIENT"]' items: type: string Single transaction over threshold: type: object required: - template - amountThreshold properties: template: type: string enum: - SingularTransaction amountThreshold: type: string description: Threshold of the transaction which should trigger the alert (equal or more) entityRisk: type: string description: Specify for which risk level you want to implement this rule, if for all you can leave this field empty enum: - LOW - MEDIUM - HIGH direction: type: string description: Payin or payout depending on which transaction should trigger the alert enum: - PAYIN - PAYOUT - '' jurisdictions: type: string description: Specify for transactions from which jurisdictions you want the alert to be triggered (if not provided, will be triggered for all). Ex. [GB, NL, PL, US] age: type: object properties: condition: type: string enum: - ABOVE - BELOW value: type: integer format: int32 entityType: type: string enum: - INDIVIDUAL - BUSINESS entityExternalTypes: type: array description: '["END_USER", "USER", "CLIENT"]' items: type: string Spike in avg activity: type: object required: - template - shortPeriod - longPeriod - amountThreshold - thresholdPercentage - transactionCountThreshold properties: template: type: string enum: - SpikeInAvgActivity shortPeriod: type: string description: Specify short period of the spike in activity enum: - 4h - 8h - 12h - 1d - 2d - 7d - 14d - 30d - 45d - 60d - 90d longPeriod: type: string description: Specify period of average activity which will be compared with short period enum: - 4h - 8h - 12h - 1d - 2d - 7d - 14d - 30d - 45d - 60d - 90d amountThreshold: type: string description: Threshold of the transaction which should trigger the alert (equal or more) thresholdPercentage: type: string description: 'Specify how many percent of the funds deposited should have been withdrawn in order for alert to be triggered. Ex: 80.0' transactionCountThreshold: type: string description: 'Specify how many transactions minimum have to be deposited in order for alert to be triggered. Ex: 1,3,5' age: type: object properties: condition: type: string enum: - ABOVE - BELOW value: type: integer format: int32 entityType: type: string description: INDIVIDUAL, BUSINESS enum: - '' entityExternalTypes: type: array description: '["END_USER", "USER", "CLIENT"]' items: type: string Structured transactions: type: object required: - template - timePeriod - amountThreshold - amountPercentage - transactionCountThreshold properties: template: type: string enum: - StructuredTransactions timePeriod: type: string description: Specify time period for structured transactions enum: - 4h - 8h - 12h - 1d - 2d - 7d - 14d - 30d - 45d - 60d - 90d amountThreshold: type: string description: Threshold of the transaction which should trigger the alert (equal or more) amountPercentage: type: string description: 'Specify the percentage of the threshold which should trigger the alert. Ex: 80.0' transactionCountThreshold: type: string description: 'Specify how many transactions minimum have to be deposited in order for alert to be triggered. Ex: 1' age: type: object properties: condition: type: string enum: - ABOVE - BELOW value: type: integer format: int32 entityType: type: string enum: - INDIVIDUAL - BUSINESS entityExternalTypes: type: array description: '["END_USER", "USER", "CLIENT"]' items: type: string Numerous Counterparties: type: object required: - timePeriod properties: counterpartiesCountThreshold: type: integer description: Threshold of the counterparties which should trigger the alert (equal or more) format: int64 direction: type: string description: Payin or payout depending on which transaction should trigger the alert timePeriod: type: string description: Specify time period for transactions enum: - 4h - 8h - 12h - 1d - 2d - 7d - 14d - 30d - 45d - 60d - 90d amountThreshold: type: string description: Threshold of the transaction which should trigger the alert (equal or more) age: type: object properties: condition: type: string enum: - ABOVE - BELOW value: type: integer format: int32 entityType: type: string enum: - INDIVIDUAL - BUSINESS entityExternalTypes: type: array description: '["END_USER", "USER", "CLIENT"]' items: type: string Monthly Turnover Percentage: type: object properties: percentageThreshold: type: integer format: int32 timePeriod: type: string description: Specify time period for transactions enum: - 4h - 8h - 12h - 1d - 2d - 7d - 14d - 30d - 45d - 60d - 90d entityRisk: type: string description: Specify for which risk level you want to implement this rule, if for all you can leave this field empty enum: - LOW - MEDIUM - HIGH age: type: object properties: condition: type: string enum: - ABOVE - BELOW value: type: integer format: int32 entityType: type: string description: INDIVIDUAL, BUSINESS enum: - '' entityExternalTypes: type: array description: '["END_USER", "USER", "CLIENT"]' items: type: string alert: type: object properties: raiseNewAfter: type: string description: Specify when the new alert for the same rule should be triggered, if the alert for this rule and specific entity is still open enum: - 1s - 1h - 4h - 8h - 12h - 1d - 2d - 7d - 14d - 30d - 45d - 60d - 90d eventsOrderedBy: type: string description: Specify if the events for alert should be ordered by value or date enum: - DATE - VALUE quietPeriod: type: string description: Specify the time when the alert for the specific entity and rule should not be triggered if there was the same alert created and resolved enum: - 1s - 1h - 4h - 8h - 12h - 1d - 2d - 7d - 14d - 30d - 45d - 60d - 90d status: type: string enum: - ENABLED responses: '201': description: '201' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} deprecated: false tags: - Rules get: summary: List Rules description: '' operationId: oxygen-list-rules parameters: - name: category in: query description: Category of the rule, e.g. velocity schema: type: string enum: - CHANGE_IN_ACTIVITY - STRUCTURING - HIGH_VALUE_VOLUMES - VELOCITY - name: status in: query description: Status of the rule schema: type: string enum: - ENABLED - DISABLED - name: template in: query description: Template based on which rule has been created schema: type: string enum: - SingularTransaction - CumulativeTransactionAmount - HighVolumesOnNewEntity - FastInFastOut - SpikeInAvgActivity - ActivityOnDormantAccount responses: '200': description: '200' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} deprecated: false tags: - Rules /rules/:ruleId: patch: summary: Update rule description: '' operationId: update-rule parameters: - name: ruleID in: path schema: type: string required: true requestBody: content: application/json: schema: type: object properties: status: type: string enum: - ENABLED - DISABLED responses: '200': description: '200' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} deprecated: false tags: - Rules /rules/{id}: get: summary: Get Rule description: '' operationId: oxygen-get-rule parameters: - name: id in: path description: Id of the rule schema: type: string required: true responses: '200': description: '200' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} deprecated: false tags: - Rules components: securitySchemes: sec0: type: oauth2 flows: {} x-readme-fauxas: true x-provenance: method: searched source: https://docs.fiatrepublic.com/reference harvested: '2026-10-14' tool: harvest-readme-openapi.py note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored. assembled_from: - https://docs.fiatrepublic.com/reference/create-transaction.md - https://docs.fiatrepublic.com/reference/oxygen-create-entity.md - https://docs.fiatrepublic.com/reference/oxygen-create-investigations.md - https://docs.fiatrepublic.com/reference/oxygen-create-payment-channel.md - https://docs.fiatrepublic.com/reference/oxygen-create-rule.md - https://docs.fiatrepublic.com/reference/oxygen-create-webhook.md - https://docs.fiatrepublic.com/reference/oxygen-delete-webhook.md - https://docs.fiatrepublic.com/reference/oxygen-get-alert.md - https://docs.fiatrepublic.com/reference/oxygen-get-entity.md - https://docs.fiatrepublic.com/reference/oxygen-get-investigation.md - https://docs.fiatrepublic.com/reference/oxygen-get-one-payment-channel.md - https://docs.fiatrepublic.com/reference/oxygen-get-platform-user.md - https://docs.fiatrepublic.com/reference/oxygen-get-rule.md - https://docs.fiatrepublic.com/reference/oxygen-get-webhook.md - https://docs.fiatrepublic.com/reference/oxygen-list-alerts.md - https://docs.fiatrepublic.com/reference/oxygen-list-entities.md - https://docs.fiatrepublic.com/reference/oxygen-list-investigations.md - https://docs.fiatrepublic.com/reference/oxygen-list-payment-channel.md - https://docs.fiatrepublic.com/reference/oxygen-list-platform-users.md - https://docs.fiatrepublic.com/reference/oxygen-list-rules.md - https://docs.fiatrepublic.com/reference/oxygen-list-transactions.md - https://docs.fiatrepublic.com/reference/oxygen-list-webhooks.md - https://docs.fiatrepublic.com/reference/oxygen-update-investigation.md - https://docs.fiatrepublic.com/reference/oxygen-update-webhook.md - https://docs.fiatrepublic.com/reference/update-rule.md merge: pages: 25 deduped: 24 conflicts_kept_first: 0