Spring til indhold
Forta Pay
English Log ind Book en samtale

Reference

Afregning

Forta Pay API v1

8 operationer

Afregninger pr. kreditor pr. dag pr. rør — hvad der er landet på KREDITORS konto, med bankreference og leverance-id

GET /settlements

Parametre

cursor

query · string · valgfri

limit

query · integer · valgfri

creditor_id

query · string · valgfri

date

query · string (date) · valgfri

updated_after

query · string (date-time) · valgfri

K5: alle lister har updated_after

Svar

200

OK · Page

curl
curl -X GET https://api.fortapay.dk/v1/settlements \
  -H "Authorization: Bearer $FP_KEY"

Hent afregning inkl. betalingslinjer, gebyrer (tredjepart) og afstemningsstatus

GET /settlements/{settlementId}

Parametre

settlementId

path · string · påkrævet

Svar

200

OK · Settlement

curl
curl -X GET https://api.fortapay.dk/v1/settlements/{settlementId} \
  -H "Authorization: Bearer $FP_KEY"

Markér afstemt mod bank (beløb + bankpostering-reference) — eller meld difference

POST /settlements/{settlementId}/reconcile

Parametre

settlementId

path · string · påkrævet

Idempotency-Key

header · string (uuid) · påkrævet

Obligatorisk på alle POST/PATCH/DELETE. Lever 24 timer.

Krop · object

bank_reference

string · valgfri

bank_amount

Money · valgfri

Svar

200

OK · Settlement

curl
curl -X POST https://api.fortapay.dk/v1/settlements/{settlementId}/reconcile \
  -H "Authorization: Bearer $FP_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d @- <<'JSON'
{}
JSON

Eksport (CSV eller JSON) — sikker GET, ren læsning

GET /settlements/{settlementId}/export

Én linje pr. betaling på afregningen og én NEGATIV pr. tilbageførsel på den (Reversal.settlement_id). Beløb i øre som heltal. Kontrolsummen (gross, reversals_total, third_party_fees, net_expected) står i hovedet — CSV: første linje som #-kommentar; JSON: totals — og SKAL passe med afregningen: Σ payment = gross, Σ reversal = reversals_total, Σ gebyr = third_party_fees. Passer den ikke, svares 409 settlement_inconsistent med difference, og ingen fil udleveres. CSV: UTF-8 med BOM, ; som skilletegn; tekstceller der begynder med = + - @ får et foranstillet ' (regnearksformler). Intet debitornavn — kun kreditors egne referencer. ÆNDRET (STL-EXP): economic_journal fjernet (B9-jobbet skriver kassekladden; en eksport af samme linjer er dobbeltbogføring) og bs0602 fjernet (den rå fil gemmes ikke og kan dække flere kreditorer) → 422 unsupported_export_format.

Parametre

settlementId

path · string · påkrævet

format

query · string · valgfri

Svar

200

Fil (Content-Disposition attachment; filename=afregning-<dato>-<rør>-<id>.<format>) · string

404

Fejl (RFC 9457) · Problem

409

Fejl (RFC 9457) · Problem

422

Fejl (RFC 9457) · Problem

curl
curl -X GET https://api.fortapay.dk/v1/settlements/{settlementId}/export \
  -H "Authorization: Bearer $FP_KEY"

Indlæs én udbyderafregning (udbyderens udbetaling til kreditors bank) med dens linjer

POST /creditors/{creditorId}/provider-settlements

Kildeneutral form: udbyderens opsummering (brutto, refunderinger, chargebacks, gebyrer, reserve, andet, netto), udbetalingsdag og bankreference, og LINJERNE med fortegn set fra kreditor (capture +, refund/chargeback −, gebyr trukket −). QuickPays API har INGEN afregningsdata (målt 26-09-2026); kilden er i dag udbyderens portal eller rapport (source=manual). En linje kobles til Forta Pays betaling via QuickPays betalings-id (scheme_reference) — kun entydigt; en refundering/chargeback også til Forta Pays tilbageførsel.

Samme (provider, provider_account, settlement_ref) med samme indhold → den eksisterende (200). Med ANDET indhold → 409 provider_settlement_conflict (en afregning rettes aldrig tavst). Udbyderens regnestykke valideres IKKE ved importen: går det ikke op, bliver det et arbejdspunkt i afstemningen.

Parametre

creditorId

path · string · påkrævet

Idempotency-Key

header · string (uuid) · påkrævet

Obligatorisk på alle POST/PATCH/DELETE. Lever 24 timer.

Krop · ProviderSettlementImport

provider

string · påkrævet

clearhaus · vipps_mobilepay · quickpay · other

provider_account

string · valgfri

Merchant-/ledger-id hos udbyderen ('' = kun én)

settlement_ref

string · påkrævet

Udbyderens id for afregningen (Clearhaus settlement-id · VMP pspReference på payout-scheduled)

rail

string · påkrævet

card · mobilepay

currency

string · valgfri

v1: kun DKK (422 ellers)

period_start

string | null (date) · valgfri

period_end

string | null (date) · valgfri

gross

integer · påkrævet

refunds

integer · valgfri

chargebacks

integer · valgfri

fees

integer · valgfri

reserve

integer · valgfri

Tilbageholdt (+) eller frigivet (−)

other

integer · valgfri

Andre poster med fortegn set fra kreditor

net

integer · påkrævet

Udbetalt til kreditors bank (øre)

bank_date

string (date) · påkrævet

Dagen beløbet står på kreditors bank

bank_reference

string | null · valgfri

Referencen på banklinjen (Clearhaus payout.reference_number)

lines

liste af ProviderSettlementLineIn · valgfri

Svar

201

Indlæst · ProviderSettlement

200

Allerede indlæst med samme indhold · ProviderSettlement

404

Fejl (RFC 9457) · Problem

409

`provider_settlement_conflict` — samme afregning er indlæst med andet indhold · Problem

422

`validation_failed` — valuta ≠ DKK, periode baglæns, et fortegn der ikke passer til linjens art, eller en ukendt betaling · Problem

curl
curl -X POST https://api.fortapay.dk/v1/creditors/{creditorId}/provider-settlements \
  -H "Authorization: Bearer $FP_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d @- <<'JSON'
{
  "provider": "clearhaus",
  "settlement_ref": "…",
  "rail": "card",
  "gross": 0,
  "net": 0,
  "bank_date": "…"
}
JSON

Afstem udbyderafregningerne mod Forta Pay nu (tredje kildeadapter på afstemningens motor, kind=provider_settlement)

POST /creditors/{creditorId}/provider-settlements/reconcile

Kobler først hvad der entydigt kan kobles. Derefter pr. afregning: udbyderens regnestykke går op, Σ linjer = netto, hver post i opsummeringen = summen af dens linjer, og hver capture/refundering/chargeback findes i Forta Pay med samme beløb. Og omvendt: hver kort-/MobilePay-betaling og PSP-refundering i Forta Pay står i en afregning inden for fristen (bankdage). Hvert defekt afvig er en række (et arbejdspunkt). Samme tabeller, katalog og gemmevej som POST /reconciliations; kørslen udsender reconciliation.completed. Bogføringens udbetalingsbilag dannes kun for en afregning uden én defekt.

Parametre

creditorId

path · string · påkrævet

Idempotency-Key

header · string (uuid) · påkrævet

Obligatorisk på alle POST/PATCH/DELETE. Lever 24 timer.

Svar

201

Kørt og gemt · Reconciliation

404

Fejl (RFC 9457) · Problem

curl
curl -X POST https://api.fortapay.dk/v1/creditors/{creditorId}/provider-settlements/reconcile \
  -H "Authorization: Bearer $FP_KEY" \
  -H "Idempotency-Key: $(uuidgen)"

Udbyderafregninger (uden linjer), nyeste id sidst

GET /provider-settlements

Parametre

cursor

query · string · valgfri

limit

query · integer · valgfri

creditor_id

query · string · valgfri

provider

query · string · valgfri

rail

query · string · valgfri

bank_date

query · string (date) · valgfri

Svar

200

OK · Page

curl
curl -X GET https://api.fortapay.dk/v1/provider-settlements \
  -H "Authorization: Bearer $FP_KEY"

Én udbyderafregning med linjerne og Forta Pays kobling

GET /provider-settlements/{providerSettlementId}

Parametre

providerSettlementId

path · string · påkrævet

Svar

200

OK · ProviderSettlement

404

Fejl (RFC 9457) · Problem

curl
curl -X GET https://api.fortapay.dk/v1/provider-settlements/{providerSettlementId} \
  -H "Authorization: Bearer $FP_KEY"