RefCampaignDocs
Référence APIConversions

List conversions

Returns the conversions for the authenticated merchant account. Filterable by affiliate, campaign, and status.

GET
/api/v1/conversions

Returns the conversions for the authenticated merchant account. Filterable by affiliate, campaign, and status.

Authorization

bearerAuth
AuthorizationBearer <token>

API key issued from the merchant dashboard (prefix rc_live_ / rc_test_). Sent as Authorization: Bearer <token>. Used by the SDK and any direct server-to-server integration.

In: header

Query Parameters

limit?|

Page size, clamped to 100.

offset?|

Number of items to skip.

affiliate_id?|

Filter by affiliate id.

campaign_id?|

Filter by campaign id.

from?|

ISO-8601 date lower bound.

to?|

ISO-8601 date upper bound.

min_amount?|

Minimum conversion amount.

max_amount?|

Maximum conversion amount.

status?|

Filter by conversion status.

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://app.refcampaign.com/api/v1/conversions"
Empty
{
  "success": false,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "string",
    "details": null
  },
  "meta": {
    "timestamp": "2019-08-24T14:15:22Z",
    "requestId": "string"
  }
}
{
  "success": false,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "string",
    "details": null
  },
  "meta": {
    "timestamp": "2019-08-24T14:15:22Z",
    "requestId": "string"
  }
}
{
  "success": false,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "string",
    "details": null
  },
  "meta": {
    "timestamp": "2019-08-24T14:15:22Z",
    "requestId": "string"
  }
}
{
  "success": false,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "string",
    "details": null
  },
  "meta": {
    "timestamp": "2019-08-24T14:15:22Z",
    "requestId": "string"
  }
}

Refund a conversion and claw back its commission POST

Signals that a previously reported conversion was refunded or charged back. Intended for merchants billing outside Stripe Connect (e.g. Shopify Payments), where RefCampaign receives no refund webhook. The conversion is identified by its `externalId`. Omit `amount` for a full refund, or pass the refunded amount in minor units (cents, in the conversion currency) for a partial refund. Pass `refundExternalId` for each merchant refund event so successive partial refunds accumulate while retries of the same refund remain no-ops. Pending commissions are rejected; already-paid commissions get a prorated negative clawback entry. Legacy calls without `refundExternalId` remain idempotent: a second call on an already-refunded conversion is a no-op.

Get conversion summary metrics GET

Returns aggregated conversion revenue, commission and count metrics for a period, optionally grouped by status or campaign.