Spring til indhold
Forta Pay
English Log ind Book en samtale

Reference

Hostede sessioner

Forta Pay API v1

4 operationer

TILFØJET (pay-crmparitet): liste over sessioner (filtre: creditor_id, debtor_id, status, purpose, updated_after)

GET /hosted-sessions

«Hvilke links står åbne for denne kunde?» Hvert element har samme form som GET /hosted-sessions/{sessionId}, med url. status er den gemte: en session hvis expires_at er passeret, kan stå open til den næste gang røres (som ved enkeltopslaget)

Parametre

cursor

query · string · valgfri

limit

query · integer · valgfri

creditor_id

query · string · valgfri

debtor_id

query · string · valgfri

status

query · string · valgfri

purpose

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

Opret hostet betalings-/tilmeldingsvindue (kort, MobilePay, BS-tilmelding via web). Eneste vej til kort- og MP-mandater

POST /hosted-sessions

purpose: pay (betal én faktura), mandate (opret mandat), pay_and_mandate. Vinduet hostes af Forta Pay og indlejrer PSP'ens felter (redirect/iframe) — Forta Pay ser aldrig kortdata (PCI SAQ A). Forta Pay kan selv distribuere linket (send_via: email/sms) med sporbar status, eller kunden får url retur og sender selv. MobilePay kun til privatkunder (Vipps MobilePay's vilkår): er debitoren en virksomhed (type: business, cvr eller ean), svarer allowed_rails: [mobilepay] alene 422 mobilepay_kun_privat, og sammen med andre rør falder MobilePay bort (dropped_rails, samme kode).

Parametre

Idempotency-Key

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

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

Krop · HostedSessionCreate

creditor_id

string · påkrævet

debtor_id

string · påkrævet

purpose

string · påkrævet

pay · mandate · pay_and_mandate

invoice_id

string | null · valgfri

allowed_rails

liste af string · valgfri

mandate_required

boolean · valgfri

success_url

string | null (uri) · valgfri

Knappen «Tilbage til …» på kvitteringen. Kun https:// på en vært i kreditorens hvidliste (Indstillinger › Betalingsvindue) — ellers 422 return_url_not_allowed. Udeladt = kreditorens standard, hvis der er en. Debitor ser ALTID Forta Pay's kvittering først

cancel_url

string | null (uri) · valgfri

Knappen «Tilbage til …» når debitor har afbrudt betalingen. Samme hvidliste og regler som success_url

expires_in_hours

integer · valgfri

send_via

liste af string · valgfri

Lad Forta Pay distribuere linket med sporbar status: én leverance pr. kanal (GET /deliveries, emne hosted_session), status pr. kanal i svarets delivery. Ingen udbyder i live → 409 distribution_not_available, og sessionen oprettes ikke

language

string | null · valgfri

Sidens sprog. Udeladt = debitorens sprog

da · en · fo · kl · None

Svar

201

OK · HostedSession

curl
curl -X POST https://api.fortapay.dk/v1/hosted-sessions \
  -H "Authorization: Bearer $FP_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d @- <<'JSON'
{
  "creditor_id": "…",
  "debtor_id": "…",
  "purpose": "pay"
}
JSON

Hent session (status open/completed/expired/cancelled)

GET /hosted-sessions/{sessionId}

Parametre

sessionId

path · string · påkrævet

Svar

200

OK · HostedSession

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

Annullér session (POST — aldrig GET)

POST /hosted-sessions/{sessionId}/cancel

Parametre

sessionId

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 · HostedSession

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