Spring til indhold
Forta Pay
English Log ind Book en samtale

Reference

Inkasso

Forta Pay API v1

6 operationer

Inkassosager (filtre: status, debtor_id, partner)

GET /collection-cases

Parametre

cursor

query · string · valgfri

limit

query · integer · valgfri

status

query · string · valgfri

debtor_id

query · string · valgfri

partner

query · string · 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/collection-cases \
  -H "Authorization: Bearer $FP_KEY"

Overdrag én eller flere fordringer (samme debitor) til inkassopartner. Kræver status ready_for_collection og inkassolovens § 10-påkrav dokumenteret (ellers 409 med regelhenvisning) (scope admin — som i kreditorfladen; pay-sikkerhed2 T6-10)

POST /collection-cases

Fire øjne: har fordringernes kreditor slået fire øjne til, svarer kaldet 202 med en ApprovalRequest (status: pending, target_id = fakturaernes id'er sorteret og kommasepareret) i stedet for at overdrage. En ANDEN person på kreditoren godkender den i kreditorfladen; først da oprettes sagen (result_id). Kaldet prøves først: et kald der ville fejle nu, får samme fejl som uden fire øjne. Slået fra (standarden) er svaret uændret.

Parametre

Idempotency-Key

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

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

Krop · CollectionCaseCreate

invoice_ids

liste af string · påkrævet

Samme debitor

partner

string · valgfri

Partnerkode (aftales med partneren); udeladt/manual = operatøren sender pakken

note

string · valgfri

s10_exception_reason

string · valgfri

H10 — inkassoloven § 11: overdrag UDEN § 10-påkrav ved nærliggende risiko; begrundelse ≥ 20 tegn, logges på sagen med nøgle-id. 🔴 R-16: KUN i sandbox — i live 409 s11_not_available

Svar

201

OK · CollectionCase

202

Fire øjne: anmodningen (202 = oprettet, intet udført endnu) · ApprovalRequest

409

Fejl (RFC 9457) · Problem

curl
curl -X POST https://api.fortapay.dk/v1/collection-cases \
  -H "Authorization: Bearer $FP_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d @- <<'JSON'
{
  "invoice_ids": [
    "…"
  ]
}
JSON

Hent sag med partnerens sags-id, status, omkostninger, delbetalinger, indsigelser, afdragsplan

GET /collection-cases/{caseId}

Parametre

caseId

path · string · påkrævet

Svar

200

OK · CollectionCase

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

Tilbagekald sag fra partner (fx betalt direkte til kreditor)

POST /collection-cases/{caseId}/withdraw

Parametre

caseId

path · string · påkrævet

Idempotency-Key

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

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

Krop · object

reason

string · valgfri

Svar

200

OK · CollectionCase

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

Overdragelsespakken (fakturaer, rykkerhistorik med afsendelsesbeviser, kravopgørelse, debitorstamdata) som ZIP/JSON — det partneren får

GET /collection-cases/{caseId}/handover-package

Parametre

caseId

path · string · påkrævet

format

query · string · valgfri

Svar

200

Pakke (application/json · text/csv · application/zip)

404

Fejl (RFC 9457) · Problem

curl
curl -X GET https://api.fortapay.dk/v1/collection-cases/{caseId}/handover-package \
  -H "Authorization: Bearer $FP_KEY"

Manuel registrering af partnerstatus (bruges indtil partneren har API; UI-knap i portalen kalder samme endpoint)

POST /collection-cases/{caseId}/partner-update

Parametre

caseId

path · string · påkrævet

Idempotency-Key

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

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

Krop · CollectionPartnerUpdate

status

string · påkrævet

Partnerens tilstand. none, ready og withdrawn sætter Forta Pay selv og kan ikke meldes her (422)

handed_over · acknowledged · in_progress · disputed · installment_plan · legal · closed_paid · closed_partial · closed_written_off · rejected_by_partner

partner_case_ref

string · valgfri

partner_costs

Money · valgfri

payment

object · valgfri

note

string · valgfri

source_document_ref

string · valgfri

Reference til partnerens mail/brev/portal-post

installment_plan

object · valgfri

Ved status installment_plan: partnerens afdragsordning

agency

CollectionAgency · valgfri

R-20 · inkassobureauet debitor ser på den lukkede betalingsside efter overdragelsen

partner_event_id

string · valgfri

Partnerens eget hændelses-id. Samme id igen registreres ikke igen (genlevering, svaret er sagen som den står); samme id med andet indhold → 422 partner_event_reused

Svar

200

OK · CollectionCase

curl
curl -X POST https://api.fortapay.dk/v1/collection-cases/{caseId}/partner-update \
  -H "Authorization: Bearer $FP_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d @- <<'JSON'
{
  "status": "handed_over"
}
JSON