Spring til indhold
Forta Pay

Reference

Opkrævninger

Forta Pay API v1

4 operationer

Planlagte og gennemførte opkrævningsforsøg (filtre: invoice_id, mandate_id, status, charge_date)

GET /charges

Parametre

cursor

query · string · valgfri

limit

query · integer · valgfri

status

query · string · valgfri

invoice_id

query · string · valgfri

mandate_id

query · string · valgfri

charge_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/charges \
  -H "Authorization: Bearer $FP_KEY"

Hent opkrævning (inkl. BS-leverance-id og adviseringsstatus)

GET /charges/{chargeId}

Parametre

chargeId

path · string · påkrævet

Svar

200

OK · Charge

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

Annullér planlagt opkrævning inden indleveringsfrist (409 hvis allerede indleveret — BS: brug /charges/{chargeId}/stop)

POST /charges/{chargeId}/cancel

Parametre

chargeId

path · string · påkrævet

Idempotency-Key

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

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

Svar

200

OK · Charge

409

Fejl (RFC 9457) · Problem

curl
curl -X POST https://api.fortapay.dk/v1/charges/{chargeId}/cancel \
  -H "Authorization: Bearer $FP_KEY" \
  -H "Idempotency-Key: $(uuidgen)"

TILFØJET (pay-bsstop): STOP en indleveret BS-opkrævning med 0605/0253 — og (pay-vipps-partnerklar, pay-selvbetjent) annullér et MobilePay-træk via Vipps eller QuickPay

POST /charges/{chargeId}/stop

MobilePay via QuickPay (pay-selvbetjent): et varslet træk (sendt to dage før, hæves på betalingsdagen kl. 00.00) annulleres hos QuickPay af QuickPay-runden; svaret bærer stop.status = requested, og opkrævningen bliver cancelled med stop.status = confirmed, når QuickPay har bekræftet. Forta Pay tager imod stoppet til dagen før betalingsdagen kl. 23.00; derefter 409 charge_stop_deadline_passed med stop_deadline. Hæves trækket alligevel, står betalingen, og stop.status = failed. Et kort-træk hæves i samme kald som det sendes og kan ikke stoppes (409 charge_stop_not_supported). MobilePay via Vipps (pay-vipps-partnerklar): en opkrævning bundet til en Vipps-aftale annulleres hos Vipps (DELETE på trækket, MÅLT synkront i MT: 204 → CANCELLED); svaret er normalt cancelled med stop.status = confirmed, og stop.deadline er null. Gik Vipps' svar tabt, står stop.status = requested, og afstemningen afgør det. Et træk Vipps har hævet, giver 409 charge_not_stoppable — refund er vejen. Betalingsservice: submitted/accepted. Ligger posten stadig i den åbne 0601, trækkes den ud og annulleres straks. Er 0601'en sendt, anmodes et stop: status flytter først når BS har bekræftet (charge.cancelled); indtil da bærer svaret stop.status = requested. Stoppets kundenr., mandatnr., debitorgruppe og betalingsdag tages fra den 0601-post der FAKTISK blev sendt. Fristen er bankdagen før betalingsdagen (GDS 11-02-2025 s.117); Forta Pay tager imod stop til kl. 11.00 dén dag (stop.deadline) — det klokkeslæt er Forta Pays egen margen, BS oplyser intet. Efter fristen: 409 bs_stop_deadline_passed med stop_deadline. Idempotent: et stop der allerede er anmodet/bekræftet, returneres uændret

Parametre

chargeId

path · string · påkrævet

Idempotency-Key

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

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

Svar

200

OK · Charge

409

Fejl (RFC 9457) · Problem

curl
curl -X POST https://api.fortapay.dk/v1/charges/{chargeId}/stop \
  -H "Authorization: Bearer $FP_KEY" \
  -H "Idempotency-Key: $(uuidgen)"