Oxygen Integration

🧭 Member Integration Flow

Step 1️⃣: Map and Create Entities

• Map your internal users to one of:
  • INDIVIDUAL
  • BUSINESS
• Use POST /entities with your externalId
• You’ll use this externalId to reference the entity later (e.g., in transactions or rules)

Step 2️⃣: (Optional) Create Payment Channels

• Optional step to define accounts or funding sources
• Used by specific rules like "Numerous counterparties"
• Use POST /payment-channels with a known externalId

Step 3️⃣: Define Rules

• Use POST /rules to set up monitoring logic
• Example fields to build rules:
  • riskRating (e.g., trigger if MEDIUM risk deposits increase)
  • externalCreatedAt (e.g., high volume from new user)
  • annualSalary / annualTurnover (e.g., alert on deposits exceeding X%)

Step 4️⃣: Send Transactions

• Use POST /transactions with:
  • Payer/Payee entity IDs using your externalId
• Transactions are evaluated against your active rules

✅ You're now ready!

Once rules are live and transactions are flowing, alerts will trigger based on your defined logic.

⚠️ Important Disclaimer

• The ingestion API is tolerant: if your request passes validation, a 202 Accepted means the object is created
• Using externalId gives you full control: you know exactly what ID to query, use, or reference in all flows.