API-lösningen omfattar fyra huvudsakliga funktioner. Nedan följer en beskrivning av funktionerna, hur informationsflödet ser ut och hur statusar används i lösningen. Det finns även viktiga tidsaspekter att ta hänsyn till inför anslutning till den digitala tjänsten Fritidskortet.

Övergripande beskrivning av funktionalitet

Uppslag av föreningar och kulturskolor i Fritidskortets register

Funktion för att kontrollera om en förening eller kulturskola ingår i Fritidskortets register och är godkänd för att ta emot utbetalningar från E-hälsomyndigheten. Informationen kan användas för att avgöra om Fritidskortet ska visas som ett betalningsalternativ för det aktuella betalunderlaget.

Skicka in betaluppgifter

Funktion för att skicka in betaluppgifter till fritidskortstjänsten och initiera en betalsession. Betaluppgifterna används som underlag för en ansökan som signeras av vårdnadshavaren i fritidskortstjänsten. Uppgifterna i ansökan, exempelvis Bank-/Plusgironummer och betalningsreferens, ligger sedan till grund för utbetalningen av det ekonomiska stödet. 

Hämta betalningsstatus

Funktion för att hämta status för en betalsession. Möjliga statusar detaljeras nedan.

Ge signal om att utbetalning ska ske

Funktion för att bekräfta att E-hälsomyndigheten kan betala ut beviljat belopp. En betalsession behöver ha status Betalning beslutad innan en signal om utbetalning kan skickas.

Anropsflöde

Steg 1 - Uppslag av förening eller kulturskola i Fritidskortets register

Flödet startar med att föreningssystemet kontrollerar att den aktuella föreningen eller kulturskolan finns med i Fritidskortets register och därmed är en godkänd mottagare av det ekonomiska stödet. Om så är fallet kan föreningssystemet presentera Fritidskortet som ett giltigt betalningsalternativ för vårdnadshavaren.

Steg 2 - Skicka betaluppgifter till fritidskortstjänsten

Vårdnadshavaren väljer Fritidskortet som betalningsalternativ. Föreningssystemet skickar betaluppgifter till fritidskortstjänsten och får tillbaka ett id för betalsessionen.

Steg 3 - Hämta status för en betalsession

Vårdnadshavaren slussas till fritidskortstjänsten för att signera sin ansökan om att använda Fritidskortet för det aktuella betalunderlaget. Parallellt med detta kan föreningssystemet skicka upprepade frågor till fritidskortstjänsten för att erhålla status på betalsessionen. Vid status Betalning beslutad får föreningssystemet även information om vilket belopp som har beviljats.

Steg 4 - Skicka signal om utbetalning

För att en utbetalning av ska ske behöver föreningssystemet skicka en signal till fritidskortstjänsten. Vid en sådan signal initierar fritidskortstjänsten en utbetalning till den aktuella föreningen eller kulturskolan. Föreningssystemet erhåller en bekräftelse tillsammans med en betalreferens för eventuell återbetalning.

Figur: Normalflöde där betalsessionen går från Pågående till Betalning beslutad.

Beskrivning av statusar

En betalsession kan ha ett av fem olika status-värden. I normalfallet går livscykeln från Pågående till Betalning beslutad, men det finns även tre statusar som ger information om avvikande händelser. 

Figur: Statusar som kan returneras av fritidskortstjänsten

Pågående

När betaluppgifter skickas in till fritidskortstjänsten skapas en betalsession med status Pågående. Denna status kommer att returneras till dess att någon av nedanstående statusar blir aktuella.

Avbruten

En betalsession får status Avbruten när en vårdnadshavare aktivt väljer att avbryta flödet i fritidskortstjänsten.

Utgången

En betalsession får status Utgången om ansökan i fritidskortstjänsten inte signerats av vårdnadshavaren inom den tidsgräns som gäller (se nedan). Nya uppgifter behöver då skickas in från föreningssystemet.

Nekad

En betalsession får status Nekad om vårdnadshavarens ansökan om att använda Fritidskortet avslås av E-hälsomyndigheten. Vid nekande kommer ingen utbetalning att ske.

Betalning beslutad

En betalsession får status Betalning beslutad när vårdnadshavarens ansökan om att använda Fritidskortet beviljas av E-hälsomyndigheten. När en betalsession nått denna status behöver föreningssystemet signalera om beslutet ska verkställas, d.v.s. att utbetalning av det ekonomiska stödet ska ske.

Tidsfönster

I flödet finns två tidsfönster att ta hänsyn till. Det första gäller vårdnadshavaren och det andra gäller föreningssystemet.

Tidsgräns 1 - Betaluppgifterna måste användas inom 15 minuter

Vårdnadshavaren har 15 minuter på sig att signera ansökan baserad på uppgifterna från föreningssystemet. Tiden räknas från det att föreningssystemet skickat in uppgifterna till fritidskortstjänsten.

Tidsgräns 2 - Signal om utbetalning måste skickas inom 15 minuter 

En signal om att utbetalning ska ske behöver skickas av föreningssystemet inom 15 minuter från det att betalsessionen har fått status Betalning beslutad.

Anropsbegränsning samt anropsfrekvens hämta status

Den totala mängden anrop mot tjänsten är begränsad till 25 anrop per sekund.

Funktionen för att hämta status för en given betalsession får anropas med en frekvens på högst ett anrop var tionde sekund. Anrop till funktionen ska upphöra när betalsessionen gått över från Pågående till någon av övriga statusar.