Spring til indhold
Forta Pay
English Log ind Book en samtale

Reference

Gentilmelding

Forta Pay API v1

3 operationer

Gentilmeldingskampagnens PRØVE — FarPays kort-/MobilePay-aftaler matchet mod debitorerne (scope admin — som i kreditorfladen; pay-sikkerhed3 T6-10b)

POST /reenrollment-campaigns

Kort- og MobilePay-aftaler kan ikke flyttes fra et andet system; debitorerne inviteres til at tilmelde sig igen (B17). Hver række matches på customer_number → debitorens external_ref. dry_run: true → 200 med rapporten, INTET skrevet. Ellers 201 med en kladde (draft) og samme rapport. Intet sendes af dette kald. Har kreditoren valgt «MobilePay via partnerskift» (G45: aftalerne på salgsstedet bevares ved et partnerskift), er MobilePay-rækkerne stadig matchet, men inviteres IKKE (skipped_partner_switch, mobilepay_mode: partner_switch); kortene gentilmeldes som før. Uden valget er alt som hidtil.

Parametre

Idempotency-Key

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

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

Krop · ReenrollmentCampaignCreate

creditor_id

string · påkrævet

source

string · valgfri

farpay_agreements

rows

liste af ReenrollmentRow · påkrævet

dry_run

boolean · valgfri

reminder_days

liste af integer · valgfri

expires_after_days

integer · valgfri

Svar

200

Prøven (dry_run) — intet skrevet · ReenrollmentCampaign

201

Kladden · ReenrollmentCampaign

422

Fejl (RFC 9457) · Problem

curl
curl -X POST https://api.fortapay.dk/v1/reenrollment-campaigns \
  -H "Authorization: Bearer $FP_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d @- <<'JSON'
{
  "creditor_id": "…",
  "rows": [
    {
      "customer_number": "…",
      "payment_type": "…",
      "farpay_agreement_id": "…"
    }
  ]
}
JSON

Kampagnen med prøven og afstemningen (tilmeldt/udløbet/afvist/annulleret/sprunget over, pr. rør)

GET /reenrollment-campaigns/{campaignId}

Parametre

campaignId

path · string · påkrævet

Svar

200

OK · ReenrollmentCampaign

404

Fejl (RFC 9457) · Problem

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

Anvend kampagnen — ét mål pr. matchet debitor; invitationerne sendes fra `send_at` (scope admin — som i kreditorfladen; pay-sikkerhed2 T6-10)

POST /reenrollment-campaigns/{campaignId}/apply

send_at er PÅKRÆVET og har ingen standard. Kaldet sender intet: invitationerne sendes af planlæggeren når send_at er nået (én hostet session pr. debitor, send_via e-mail, + SMS for tidligere MobilePay-brugere), og påmindelser reminder_days efter. Genkørsel opretter 0 nye mål. Et andet send_at flytter tidspunktet, så længe intet er sendt — ellers 409 campaign_already_sending.

Parametre

campaignId

path · string · påkrævet

Idempotency-Key

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

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

Krop · ReenrollmentApply

send_at

string (date-time) · påkrævet

Hvornår invitationerne sendes. Ingen standard

Svar

200

OK · ReenrollmentCampaign

404

Fejl (RFC 9457) · Problem

409

`campaign_already_sending`, `campaign_closed`, `campaign_overlap` (debitorer venter allerede i en anden, ikke-afsluttet kampagne hos kreditoren — ellers to invitationer; `overlapping_debtors` = antal) eller `campaign_mobilepay_policy_changed` (kreditorens MobilePay-valg er ændret efter prøven — lav en ny prøve) · Problem

curl
curl -X POST https://api.fortapay.dk/v1/reenrollment-campaigns/{campaignId}/apply \
  -H "Authorization: Bearer $FP_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d @- <<'JSON'
{
  "send_at": "…"
}
JSON