Naam component waarvoor API voorzien wordt

Betaalmodule

Doel

Met deze API kunt u een betaallink aanmaken zodat uw klanten meteen kunnen betalen voor een dienstverlening (order).
U kunt ook statusupdates krijgen over de betaling van het order.

Klant

• Vlaamse overheidsdiensten

• Lokale besturen

Gevolg

• Via de API kan er een betaallink met QR-code worden aangemaakt op basis van de doorgegeven betaalgegevens.

• Via de API kan een lijst met betalingen en bijhorende data voor een orderID worden opgevraagd. Hiermee kunt u de status van de betaling checken.

Specificaties API

Zie hieronder: https://vlaamseoverheid.atlassian.net/wiki/spaces/IKPubliek/pages/6044352886/Specificaties+Betaalmodule-API#OpenAPI-specificaties

Link met de Aanvraagmodule

Zie ook https://vlaamseoverheid.atlassian.net/l/cp/WwW19fQ2

Bijv. Kwalificatiekaart bestuurder van Departement Mobiliteit en Openbare Werken waar bij de aanvraag van de kwalificatiekaart ook een betaling nodig. Hiervoor gebruikt DMOW zowel de Aanvraag- als de Betaalmodule.

orderID

Het orderID identificeert het order. U kiest dit zelf.

Bijv. UUID v4 om een uniek orderID aan te maken

string

Ja

descriptionText

De beschrijving van het betalingsverzoek. POM zal deze weergeven in het betalingsscherm.

string

Neen

descriptionUrl

Plaatst een HTML-link achter de beschrijving van het betalingsverzoek om bijv. te verwijzen naar een informatiepagina over het product of de dienst

string

Neen

amount

Het te betalen bedrag voor het order tot op 2 cijfers achter het decimale punt

string

Ja

dueDate

De uiterste betaaldatum

Deze datum hoeft alleen meegegeven te worden voor wie wil afwijken van de standaardwaarde die werd meegegeven bij de aansluiting.

De betaling gebeurt in principe meteen, dus de dueDate zal gewoonlijk de datum van morgen zijn.

string

Neen

communication

Dit veld wordt genegeerd indien u een OraFin-aansluiting heeft.

Indien u geen OraFin-aansluiting heeft, moet in dit veld een vrije mededeling meegegeven worden.

string

Conditioneel

paymentMethod

Als het contract met de Payment Service Provider toestaat om dit veld leeg te laten, kan de betaler elke methode gebruiken die op het contract voorzien is.

U kunt ervoor kiezen deze methodes te beperken door een specifieke methode mee te sturen.

Neem contact op met de PSP om te weten welke methoden op uw contract zijn toegestaan.

String

Neen

expiryDate

De datum waarop het betalingsverzoek vervalt in UTC-formaat. Deze datum moet minstens gelijk zijn aan de dueDate.

Indien dit veld leeggelaten wordt, zal by default de vervaldatum (expirydate) worden overgenomen uit het aansluitingsformulier.

string

Neen

language

De taal van het betalingsverzoek:

• 2 karakters voor de taalcode volgens ISO 639

• gevolgd door '_'

• gevolgd door 2 karakters voor de landcode volgens ISO 3166-2

Bijvoorbeeld: nl_BE

Indien u dit veld leeg laat, wordt er bij default nl_BE gehanteerd.

string

Neen

ipdcCode

De IPDC-code van het product.

Dit veld is altijd verplicht. Als u een OraFin-aansluiting heeft, wordt de IPDC-code gebruikt voor de boekhouding in OraFin.

Gebruik hier de code uit de IPDC-dienstencatalogus.

Bijvoorbeeld: 961

Zie ook https://productencatalogus.vlaanderen.be/

string

Ja

redirectUrl

U kunt een URL doorgeven naar waar er geredirect wordt na het afronden van een online betaling. Zo kan de betaler naar de gewenste context worden gestuurd.

U kunt ook een vaste URL configureren bij de PSP.

string

Neen

customerType

Geeft mee of de betaling voor een particuliere of een professionele aankoop gebeurt.

Dit veld is verplicht als u een OraFin-aansluiting heeft. Mogelijke waarden zijn KSZ (voor een particuliere aankoop) of KBO (voor een professionele aankoop).

String

Indien OraFin-aansluiting: Ja

Indien geen OraFin-aansluiting: Neen

insz

Het rijksregisternummer voor een particuliere aankoop.

Dit veld is verplicht als u een OraFin-aansluiting heeft en het customerType = KSZ.

Bijvoorbeeld: 82200501055

String

Indien OraFin-aansluiting EN customerType = KSZ: Verplicht veld

Anders: geen verplicht veld

kboNumber

Het KBO-nummer voor een professionele aankoop. Dit veld is verplicht als u een OraFin- aansluiting heeft en het customerType = KBO.

Bijvoorbeeld: 7682949223

String

Indien OraFin -aansluiting EN customerType = KBO: Verplicht veld

Anders: geen verplicht veld

200

OK

Succesvolle respons, er wordt een betaallink en QR-code teruggegeven.

400

Bad request

Foutmelding, er wordt geen betaallink en QR-code teruggegeven.

403

Forbidden

Foutmelding, er wordt geen betaallink en QR-code teruggegeven.

404

Not found

Foutmelding, er wordt geen betaallink en QR-code teruggegeven.

451

Unavailable For Legal Reasons

Foutmelding, er wordt geen betaallink en QR-code teruggegeven.

500

Internal Server Error

Foutmelding, er wordt geen betaallink en QR-code teruggegeven.

503

Service Unavailable

Foutmelding, er wordt geen betaallink en QR-code teruggegeven.

orderID

Het orderID identificeert het order. U kiest het orderID zelf.

Bijv. UUID v4 om een uniek orderID aan te maken.

string

Ja

Limit

Dit veld bevat de paginagrootte van de respons en is standaard ingesteld op 10.

Integer

Nee

Offset

Dit veld bevat de pagina-offset van de response, en is standaard ingesteld op 0.

Integer

Nee

200

OK

Succesvolle respons, er wordt een lijst met de bijhorende betaling(en) en gegevens voor het orderID teruggegeven.

400

Bad Request

Foutmelding, er wordt geen lijst met de bijhorende betaling(en) en gegevens voor het orderID teruggegeven.

403

Forbidden

Foutmelding, er wordt geen lijst met de bijhorende betaling(en) en gegevens voor het orderID teruggegeven.

404

Not Found

Foutmelding, er wordt geen lijst met de bijhorende betaling(en) en gegevens voor het orderID teruggegeven.

451

Unavailable For Legal Reasons

Foutmelding, er wordt geen lijst met de bijhorende betaling(en) en gegevens voor het orderID teruggegeven.

500

Internal Server Error

Foutmelding, er wordt geen lijst met de bijhorende betaling(en) en gegevens voor het orderID teruggegeven.

503

Service Unavailable

Foutmelding, er wordt geen lijst met de bijhorende betaling(en) en gegevens voor het orderID teruggegeven.

paymentID

Het paymentID identificeert de betaling zoals gegeven door de Betaalmodule.

String

Ja

200

OK

Succesvolle respons, er wordt een lijst met bijhorende status(sen) gegeven op basis van het paymentID.

400

Bad request

Foutmelding, er wordt geen lijst met bijhorende status(sen) gegeven op basis van het paymentID.

403

Forbidden

Foutmelding, er wordt geen lijst met bijhorende status(sen) gegeven op basis van het paymentID.

404

Not Found

Foutmelding, er wordt geen lijst met bijhorende status(sen) gegeven op basis van het paymentID.

451

Unavailable For Legal Reasons

Foutmelding, er wordt geen lijst met bijhorende status(sen) gegeven op basis van het paymentID.

500

Internal Server Error

Foutmelding, er wordt geen lijst met bijhorende status(sen) gegeven op basis van het paymentID.

503

Service Unavailable

Foutmelding, er wordt geen lijst met bijhorende status(sen) gegeven op basis van het paymentID.

status

Status van de respons

integer

type

Type error/ fout

string

title

Titel

string

detail

Detailinformatie over de error/ fout

string

instance

Plaats waar de error/ fout zich precies bevindt

string

orderID

Het orderID identificeert het order. U kiest het orderID zelf.

Bijv. UUID v4 om een uniek orderID aan te maken.

string

descriptionText

De beschrijving van het betalingsverzoek, POM toont deze beschrijving in het betalingsscherm.

string

descriptionUrl

Plaatst een HTML-link achter de beschrijving van het betalingsverzoek om bijv. te verwijzen naar een informatiepagina over het product of de dienst

string

amount

Het te betalen bedrag voor het order tot op 2 cijfers achter het decimale punt

string

dueDate

De uiterste betaaldatum

De betaling gebeurt in principe meteen, dus de dueDate zal gewoonlijk de datum van morgen zijn.

string

communication

Dit veld wordt genegeerd indien u een OraFin-aansluiting heeft.

Indien u geen OraFin-aansluiting heeft, moet in dit veld een vrije mededeling meegegeven worden.

string

paymentMethod

Als het contract met de Payment Service Provider toestaat om dit veld leeg te laten, kan de betaler elke methode gebruiken die op het contract voorzien is.

U kunt ervoor kiezen deze methodes te beperken door een specifieke methode mee te sturen.

Neem contact op met de PSP om te weten welke methoden op uw contract zijn toegestaan.

string

expiryDate

De datum waarop het betalingsverzoek vervalt in UTC-formaat. Deze datum moet groter zijn of gelijk zijn aan de dueDate + 1 dag.

Indien dit veld leeggelaten wordt, zal by default de vervaldatum (expirydate) worden overgenomen uit het aansluitingsformulier.

string

language

De taal van het betalingsverzoek:

• 2 karakters voor de taalcode volgens ISO 639

• gevolgd door '_'

• gevolgd door 2 karakters voor de landcode volgens ISO 3166-2

Bijvoorbeeld: nl_BE

Indien u dit veld leeg laat, wordt er bij default nl_BE gehanteerd.

string

ipdcCode

De IPDC-code van het product.

Dit veld is altijd verplicht. Als u een OraFin-aansluiting heeft, wordt de IPDC-code gebruikt voor de boekhouding in OraFin.

Gebruik hier de code uit de IPDC-dienstencatalogus.

Bijvoorbeeld: 961

Zie ook https://productencatalogus.vlaanderen.be/

string

redirectUrl

U kunt een URL doorgeven naar waar er geredirect wordt na het afronden van een online betaling. Zo kan de betaler naar de gewenste context worden gestuurd.

U kunt ook een vaste URL configureren bij de PSP.

string

customerType

Geeft mee of de betaling voor een particuliere of een professionele aankoop gebeurt.

Dit veld is verplicht als u een OraFin-aansluiting heeft. Mogelijke waarden zijn KSZ (voor een particuliere aankoop) of KBO (voor een professionele aankoop).

String

insz

Het rijksregisternummer voor een particuliere aankoop.

Dit veld is verplicht als u een OraFin-aansluiting heeft en het customerType = KSZ.

Bijvoorbeeld: 82200501055

String

kboNumber

Het KBO-nummer voor een professionele aankoop. Dit veld is verplicht als u een OraFin- aansluiting heeft en het customerType = KBO.

Bijvoorbeeld: 7682949223

String

orderID

Het orderID identificeert het order. U kiest het orderID zelf.

string

paymentID

Het paymentID identificeert de betaling zoals meegegeven door de Betaalmodule.

string

pspPaymentID

Het pspPaymentID identificeert de betaling zoals meegegeven door de Payment Service Provider.

string

paylink

Dit is de betaallink die werd gecreëerd.

string

additionalLinks

Bijkomende links

• SMS

• QR

• WEB

string

communication

Indien van toepassing, wordt in dit veld de gestructureerde mededeling geplaatst.

Dit veld wordt alleen teruggegeven voor klanten die een OraFin-aansluiting hebben.

string

error

Foutmelding, indien van toepassing zal er een as-is-fout terugkomen van de payment service provider.

string

paylink

Dit is de paylink-/ betaallink-URL voor het kanaal in kwestie.

string

paylinkShort

Dit is een verkorte versie van de url van de betaallink. Deze lijkt niet aanwezig voor WEB.

string

orderID

Het orderID identificeert het order. U kiest het orderID zelf.

String

paymentID

Het paymentID identificeert de betaling zoals meegegeven door de Betaalmodule.

string

pspPaymentID

Het pspPaymentID identificeert de betaling zoals meegegeven door de Payment Service Provider.

String

senderContract
Number

Het contractnummer waaronder het betalingsverzoek ontvangen is.

String

descriptionText

De beschrijving/het label van het betalingsverzoek.

String

descriptionUrl

Veld waarmee u een HTLM-link plaatst achter de beschrijving van het betalingsverzoek om bijv. te verwijzen naar een informatiepagina over het product/ departement

String

amount

Het te betalen bedrag voor het order tot op 2 cijfers achter het decimale punt

String

currency

De munteenheid van het betalingsverzoek, dit zal altijd EUR (= euro) zijn.

String

documentDate

De creatiedatum van het betalingsverzoek, in het formaat YYYY-MM-DD.

String

dueDate

De uiterlijke betalingsdatum

De betaling gebeurt in principe meteen, dus de dueDate zal gewoonlijk de datum van morgen zijn.

String

paymentType

Het type betaling/document.

Dit zal in de meeste gevallen “Invoice” zijn.

String

communication

De betalingsreferentie, indien van toepassing wordt in dit veld de gestructureerde mededeling geplaatst.

Dit veld wordt alleen teruggegeven voor klanten die een OraFin-aansluiting hebben.

String

paymentMethod

De betalingsmethode die werd gekozen om de betaling uit te voeren, bijv. Visa.

String

paymentDate

Het tijdstip waarop waarop de betaalstatus op COMPLETED werd gezet, in UTC-formaat.

String

expiryDate

De datum waarop het betalingsverzoek vervalt in UTC-formaat. Deze datum moet groter zijn of gelijk zijn aan de dueDate + 1 dag.

Indien dit veld leeggelaten wordt, zal by default de vervaldatum (expirydate) worden overgenomen uit het aansluitingsformulier.

String

language

De taal van het betalingsverzoek:

• 2 karakters voor de taalcode volgens ISO 639

• gevolgd door '_'

• gevolgd door 2 karakters voor de landcode volgens ISO 3166-2

Bijvoorbeeld: nl_BE

Indien u dit veld leeg laat, wordt er bij default nl_BE gehanteerd.

String

status

De status van de betaling:

• NOT_COMPLETED

• COMPLETED

String

onlineStatus

Duidt de status van de online afhandeling van de betaling aan. De mogelijke waarden zijn:

• SUCCESS

• IN_PROGRESS

• FAILURE

Zolang de online betaling nog in uitvoering is, zal dit element ontbreken.

string

status

Duidt de status van de betaling aan. Momenteel zijn de mogelijke waarden:

• WAITING

• COMPLETED

string

offset

Dit veld bevat de paginaoffset. Dit staat default op 0, en haalt de eerste pagina op.

Een offset van 1 haalt de tweede pagina op, als die er is, etc.

Integer

size

Dit veld bevat de paginagrootte. Dit staat default op 10, maar kan worden aangepast met de limit parameter in de request.

Integer

totalItems

Dit is het totaal aantal gevonden items. Wanneer dit getal groter is dan de paginagrootte kunt u met de offset-parameter in de request de volgende pagina opvragen.

Integer