API reference

The reference is auto-generated from the live OpenAPI 3.1 spec at app.refcampaign.com/api/openapi.json — there is no manual YAML to drift out of sync with code.

Endpoints are grouped by tag in the sidebar:

• Conversions — track server-to-server conversions, refund postback conversions, list and summarize conversions.
• Campaigns — list campaigns and fetch campaign detail.
• Affiliates — list affiliates and fetch affiliate detail.
• Assets — list finalized merchant assets, create swipe copy, update metadata, archive assets.
• Commissions — list, bulk-approve, bulk-reject.
• Applications — accept or reject affiliate applications, individually or in bulk.
• Dashboard — fetch merchant KPI summaries.
• Payouts — list, create, approve, reject, and mark payouts as paid.
• System — validate an integration key with the ping endpoint.

Every operation page includes:

• The full request schema (path params, query params, JSON body) with required/optional markers.
• A response table per status code with the JSON body shape.
• Code samples in cURL, JavaScript (fetch), and Python (requests).
• A try-it-out playground that posts the request through this site's forward proxy so the browser's CORS rules don't block the response.

Authentication

All requests authenticate with a Bearer token. Generate one in the dashboard under Settings → API keys and pass it on every request:

Authorization: Bearer <YOUR_TOKEN>

The playground exposes an Authorization input at the top of each operation — paste the token there to test the endpoint live against app.refcampaign.com.

Errors

Every error returns a consistent JSON shape:

{
  "error": {
    "code": "VALIDATION_FAILED",
    "message": "currency must be a 3-letter ISO 4217 code",
    "details": { "field": "currency" }
  }
}

See error handling for the full code reference.

Monetary totals by currency

GET /api/v1/dashboard/summary returns totals.revenueTotals and totals.commissionTotals. Affiliate detail returns these arrays on each participation. Each entry contains an ISO currency code and an amount decimal string in that currency’s major unit. Example: [{"currency":"EUR","amount":"12.34"},{"currency":"JPY","amount":"500"}].

Arrays are sorted by ISO code. An empty array means no ledger rows; a zero total retains its currency. No FX conversion is applied. The summary’s former revenue and commissions scalars and participation’s totalRevenue and totalCommissions scalars are absent. MCP summary and affiliate-detail tools also show each currency separately.