Skip to main content

overview

What is Reportly?​

Reportly is 2settle's fraud and complaint reporting service. It lets your users file reports when something goes wrong with a transaction — tracking a payment, reporting stolen funds, or flagging fraud — and lets them check the status of those reports afterward.

Key Features:

  • Three Complaint Types - track_transaction, stolen_funds, fraud
  • Public Lookup - End users can check report status by phone number or wallet address, no API key needed
  • Admin Review Workflow - Reports move through pending → processing → resolved/dismissed
  • Optional Session Linking - Attach a report to a related payment reference

Authentication​

Reportly uses the same HMAC-SHA256 request signing as the Payment Engine — see Authentication for the signature generation details. Creating a report requires the report:create permission on your API key; see Permissions.

Looking up reports (GET /v1/reports/lookup and GET /v1/reports/:reportId) is public and does not require an API key.

How It Works​

┌──────────────┐     ┌──────────────┐     ┌──────────────┐
│   Your App   │     │   Reportly   │     │  2settle Admin│
└──────┬───────┘     └──────┬───────┘     └──────┬───────┘
       │                    │                    │
       │ 1. Create Report   │                    │
       │───────────────────>│                    │
       │                    │                    │
       │ 2. RPT-XXXXX (pending) │                │
       │<───────────────────│                    │
       │                    │ 3. Notify admin    │
       │                    │───────────────────>│
       │                    │                    │
       │                    │ 4. Review & update  │
       │                    │<───────────────────│
       │                    │    status           │
       │                    │                    │
       │ 5. Lookup status    │                    │
       │───────────────────>│                    │
       │<───────────────────│                    │