Skip to main content

CoreWave API Channel Documentation

Welcome to the official CoreWave API documentation portal.

Use this site as your single source of truth for:

  • Authentication and request conventions
  • Fast operator workflows and runbooks
  • Full endpoint inventory and payload reference
  • Integration rules for Bills, Transfer, Cards, and more
  • Flexible institution-specific JSON data for products, customers, accounts, loans, and fixed deposits
  • Fraud Copilot AML holds with permission-controlled staff release

Start Here

  1. Read API Channel Execution Guide for quick operational flows.
  2. Open API Channel Reference for complete endpoint and payload definitions.
  3. Read Entity Extra Data when your institution needs custom nested JSON fields.
  4. Read Fraud Copilot AML Holds before integrating transaction retries.
  5. Authenticate first with POST /api/auth/v1/authenticate, then include bearer token and request-reference on secured calls.
  6. Test requests live in API Playground.

Global Rules

  • Monetary values are in Naira.
  • API keys are auto-deactivated after 14 days of inactivity.
  • Bills, Transfer, and Card features require institution-level provider and ledger configuration.