Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Hieronder het overzicht van de attributen en de bijhorende omschrijving. Op basis van de API, wordt er een betaallink met bijhorende QR-code aangemaakt. Deze QR-code wordt weergegeven in de front-end zodat de burger kan scannen en betalen voor zijn order.

Verplichte attributen

Attribuut

Omschrijving

Type (string?)

Verplicht?

orderID

Het orderID identificeert het order. U kiest dit zelf.

Bijv. UUID v4 om een uniek orderID aan te maken

De maximale lengte van dit veld telt 36 karakters/ tekens.

string

Ja

descriptionText

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

De maximale lengte van dit veld telt 128 karakters/ tekens.

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

amount

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

Decimal, tot op 2 cijfers na de komma

Ja

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.

De maximale lengte van dit veld telt

255

36 karakters/tekens.

URL

Neen

amount

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

Decimal, tot op 2 cijfers na de komma

Ja

string

OraFin-aansluiting: nee

Geen OraFin-aansluiting: ja

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.

bijv.: 961

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

String van 3, 4 of 5 cijfers = IPDC-code

Ja

customerType

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

Mogelijke waarden zijn KSZ (voor een particuliere aankoop) of KBO (voor een professionele aankoop).

Enum (KSZ, KBO)

OraFin-aansluiting: ja

Geen OraFin-aansluiting: nee

insz

Het rijksregisternummer voor een particuliere aankoop.

Dit veld moet minimaal 10 karakters tellen.

String van 10 cijfers (RRN), zonder interpunctie

OraFin-aansluiting EN customerType = KSZ: ja

Anders: nee

kboNumber

Het KBO-nummer voor een professionele aankoop.

bijv.: 7682949223

Dit veld moet minimaal 10 karakters tellen.

String van 10 cijfers (KBO), zonder interpunctie

OraFin -aansluiting EN customerType = KBO: ja

Anders: nee

Optionele attributen

Attribuut

Omschrijving

Type (string?)

Verplicht?

descriptionText

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

De maximale lengte van dit veld telt 128 karakters/ tekens.

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

De maximale lengte van dit veld telt 255 karakters/ tekens.

URL

Neen

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 moet minstens de datum van morgen zijn.

Als er geen dueDate wordt meegegeven, wordt de geldigheidsduur van de betaallink genomen.

string

Datum in ISO 8601-formaat, bijv. 2023-05-30)

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.

De maximale lengte van dit veld telt 36 karakters/tekens.

string

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

OraFin-aansluiting: nee

Geen OraFin-aansluiting: ja

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.

Standaard worden de betaalmethoden aangeboden die tijdens de aansluiting werden gekozen.

Dit veld moet alleen meegeven worden om af te wijken van de standaard betaalmethoden die tijdens de aansluiting werden gekozen.

Neem contact op met Digitaal Vlaanderen om te weten welke

betaemethoden op uw contract zijn toegestaan.String

betaalmethoden op uw contract zijn toegestaan.

Enum of CSV-lijst van Enum

payconiq, bancontact, visa , mastercard

bijv: payconiq,visa

Neen

expiryDate

De expiryDate (tijdstip) moet in de toekomst te liggen.

Dit zijn de datum en het tijdstip waarop het betalingsverzoek vervalt in UTC-formaat

. Deze datum moet in de toekomst liggen

.

Alleen in te vullen om af te wijken van de standaardwaarde die tijdens de aansluiting werd gekozen.

Het is niet nodig zowel de dueDate als de expiryDate in te vullen. De expiryDate is voldoende.

Indien dit veld leeggelaten wordt,

zal by default

string van 3, 4 of 5 cijfers = IPDC-code

Ja

wordt de geldigheidsduur van de betaallink 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

U mag dit veld leeg laten. Er wordt dan by default nl_BE gebruikt.

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/

Datum en Tijd in ISO 8601-formaat, UTC tijdzone,

bijv. 2023-05-30T07:11:34.542Z

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

bijv.: nl_BE

U mag dit veld leeg laten. Er wordt dan by default nl_BE gebruikt.

Enum: nl_be, en_BE, fr_BE

Neen

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.

URL

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

ja

Indien geen

Geen OraFin-aansluiting:

NeenBijvoorbeeld

nee

insz

Het rijksregisternummer voor een particuliere aankoop.

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

bijv.: 82200501055

Dit veld moet minimaal 11 karakters tellen

.

String

Indien

.

String van 10 cijfers (RRN), zonder interpunctie

OraFin-aansluiting EN customerType = KSZ:

Verplicht veld

ja

Anders:

geen verplicht veld

nee

kboNumber

Het KBO-nummer voor een professionele aankoop.

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

bijv.: 7682949223

Dit veld moet minimaal 10 karakters tellen.

String

Indien

van 10 cijfers (KBO), zonder interpunctie

OraFin -aansluiting EN customerType = KBO:

Verplicht veld

ja

Anders:

geen verplicht veld

nee

Mogelijke responses

Hieronder een overzicht van de mogelijke responses op de API en de bijhorende beschrijving per respons.

...

Attribuut

Omschrijving

Type

orderID

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

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

Dit veld kan maximaal 36 karakters/ tekens tellen.

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.

De duedate dient minimaal 1 dag in de toekomst te liggen.

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.

De maximale lengte van dit veld telt 36 karakters/tekens.

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

Bijvoorbeeldbijv.: 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.

Bijvoorbeeldbijv.: 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.

Bijvoorbeeldbijv.: 82200501055

Dit veld moet minimaal 11 karakters tellen.

String

kboNumber

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

Bijvoorbeeldbijv.: 7682949223

Dit veld moet minimaal 10 karakters tellen.

String

...

Attribuut

Omschrijving

Type

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

Bijvoorbeeldbijv.: 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

...