Earnings

Commissions per conversion, balances and settlements.

List commissions

GET/v1/partner-api/commissions

What you have earned, one row per commission, newest first.

AuthPartner API key with scope reports:read

Query parameters

limitinteger1–100default 50

Items per page.

cursorstring≤ 200 chars

nextCursor from the previous page.

fromstringdate

Start, inclusive: a date (2026-11-01) or an ISO 8601 time.

tostringdate

End, inclusive: a date counts to the end of that day (UTC), or an ISO 8601 time.

statusstring

One of pending_review approved in_settlement paid rejected reversed disputed

programIdstringuuid

Only this program.

Returns · 200

itemsarray of objectsrequired

Child attributes

idstringrequireduuid

statusstringrequired

One of pending_review approved in_settlement paid rejected reversed disputed

amountintegerrequired

Minor units.

currencystringrequired

conversionIdstringrequireduuid

programIdstringrequireduuid

programNamestringrequired

campaignIdstringrequireduuid

campaignNamestringrequired

availableAtstringrequireddate-time

When the hold ends and it can be approved.

approvedAtstringrequireddate-timenullable

settlementIdstringrequireduuidnullable

createdAtstringrequireddate-time

hasMorebooleanrequired

nextCursorstringrequirednullable

Pass as cursor for the next page; null on the last one.

Errors

400validation_error: The request does not match the schema. details says which fields failed and why.
400invalid_cursor: cursor is not one this API handed out.
401invalid_api_key: No key was sent, or the key is unknown, expired or revoked.
403partner_suspended: API access is suspended for this partner account.
403insufficient_scope: The key lacks the scope this endpoint needs.
429rate_limited: Too many requests with this key in the last minute. Wait Retry-After seconds.

Request

curl "https://api.flowgroup.se/v1/partner-api/commissions" \
  -H "authorization: Bearer $FA_API_KEY"

const res = await fetch('https://api.flowgroup.se/v1/partner-api/commissions', {
  headers: {
    authorization: `Bearer ${process.env.FA_API_KEY}`,
  },
});
const data = await res.json();

200 OK

{
  "items": [
    {
      "id": "3f1c8a52-6c1e-4b8e-9d0a-2b7f0c4e5a91",
      "status": "pending_review",
      "amount": 2500,
      "currency": "USD",
      "conversionId": "3f1c8a52-6c1e-4b8e-9d0a-2b7f0c4e5a91",
      "programId": "3f1c8a52-6c1e-4b8e-9d0a-2b7f0c4e5a91",
      "programName": "programName",
      "campaignId": "3f1c8a52-6c1e-4b8e-9d0a-2b7f0c4e5a91",
      "campaignName": "campaignName",
      "availableAt": "2026-11-09T12:00:00.000Z",
      "approvedAt": "2026-11-09T12:00:00.000Z",
      "settlementId": "3f1c8a52-6c1e-4b8e-9d0a-2b7f0c4e5a91",
      "createdAt": "2026-11-09T12:00:00.000Z"
    }
  ],
  "hasMore": true,
  "nextCursor": "nextCursor"
}

Get balances and settlements

GET/v1/partner-api/payouts/summary

Your balances per currency, from pending to paid, and your ten latest settlements.

AuthPartner API key with scope reports:read

Returns · 200

environmentstringrequired

One of production sandbox

balancesarray of objectsrequired

Per currency. Empty for a sandbox key: sandbox commissions are never settled.

Child attributes

currencystringrequired

pendingintegerrequired

Minor units.

approvedintegerrequired

Minor units.

inSettlementintegerrequired

Minor units.

paidintegerrequired

Minor units.

recentSettlementsarray of objectsrequired

Child attributes

idstringrequireduuid

numberstringrequired

statusstringrequired

One of draft approved paid reconciled finalized void

currencystringrequired

totalintegerrequired

Net, before VAT.

vatAmountintegerrequirednullable

grossintegerrequirednullable

What is paid out.

periodStartstringrequireddate-time

periodEndstringrequireddate-time

paidAtstringrequireddate-timenullable

createdAtstringrequireddate-time

Errors

401invalid_api_key: No key was sent, or the key is unknown, expired or revoked.
403partner_suspended: API access is suspended for this partner account.
403insufficient_scope: The key lacks the scope this endpoint needs.
429rate_limited: Too many requests with this key in the last minute. Wait Retry-After seconds.

Request

curl "https://api.flowgroup.se/v1/partner-api/payouts/summary" \
  -H "authorization: Bearer $FA_API_KEY"

const res = await fetch('https://api.flowgroup.se/v1/partner-api/payouts/summary', {
  headers: {
    authorization: `Bearer ${process.env.FA_API_KEY}`,
  },
});
const data = await res.json();

200 OK

{
  "environment": "production",
  "balances": [
    {
      "currency": "USD",
      "pending": 1,
      "approved": 1,
      "inSettlement": 1,
      "paid": 1
    }
  ],
  "recentSettlements": [
    {
      "id": "3f1c8a52-6c1e-4b8e-9d0a-2b7f0c4e5a91",
      "number": "number",
      "status": "draft",
      "currency": "USD",
      "total": 1,
      "vatAmount": 2500,
      "gross": 1,
      "periodStart": "2026-11-09T12:00:00.000Z",
      "periodEnd": "2026-11-09T12:00:00.000Z",
      "paidAt": "2026-11-09T12:00:00.000Z",
      "createdAt": "2026-11-09T12:00:00.000Z"
    }
  ]
}

List commissions#

Get balances and settlements#

List commissions

Get balances and settlements