Spring til indhold
Forta Pay
English Log ind Book en samtale

Reference

Mandater

Forta Pay API v1

4 operationer

Liste over mandater (filtre: debtor_id, rail, status)

GET /mandates

Parametre

cursor

query · string · valgfri

limit

query · integer · valgfri

debtor_id

query · string · valgfri

rail

query · string · valgfri

status

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

Opret BS-/LS-mandat direkte (regnr/kontonr) — kort og MobilePay KAN IKKE oprettes her; brug hostede sessioner

POST /mandates

BS/LS: sendes i næste 0605-leverance (BS) hhv. LS-tilmelding; status pending_scheme indtil 0621/0603 bekræfter. Banken afviser ved ejer-mismatch → failed med failure_reason. Kort/MobilePay: 422 use_hosted_session.

Parametre

Idempotency-Key

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

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

Krop · MandateCreateBank

debtor_id

string · påkrævet

rail

string · påkrævet

bs · ls

bank_reg_no

string · påkrævet

bank_account_no

string · påkrævet

debtor_group

string | null · valgfri

BS debitorgruppenummer (kreditor kan have flere)

scheme_customer_no

string | null · valgfri

Kundenummer som det står i BS (default = external_ref)

priority

integer · valgfri

consent

object · valgfri

Dokumentation for samtykke (kanal, tidspunkt, IP/reference). BS kræver ikke CPR fra os — banken matcher kontoejer

Svar

201

OK · Mandate

422

Fejl (RFC 9457) · Problem

curl
curl -X POST https://api.fortapay.dk/v1/mandates \
  -H "Authorization: Bearer $FP_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d @- <<'JSON'
{
  "debtor_id": "…",
  "rail": "bs",
  "bank_reg_no": "…",
  "bank_account_no": "…"
}
JSON

Hent mandat

GET /mandates/{mandateId}

Parametre

mandateId

path · string · påkrævet

Svar

200

OK · Mandate

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

Opsig mandat (BS/LS afmeldes via 0605; kort/MP-token slettes hos PSP). Planlagte opkrævninger falder tilbage til FI/betalingslink

POST /mandates/{mandateId}/cancel

Parametre

mandateId

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

effective_date

string (date) · valgfri

Svar

200

OK · Mandate

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