Versions Compared

Key

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

...

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

De maximale lengte van dit veld telt 255 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

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

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

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 Digitaal Vlaanderen om te weten welke betaemethoden op uw contract zijn toegestaan.

String

Neen

expiryDate

De datum en het tijdstip waarop het betalingsverzoek vervalt in UTC-formaat. Deze datum moet in de toekomst liggen.

Indien dit veld leeggelaten wordt, zal by default 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/

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

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

Meer informatie: https://vlaamseoverheid.atlassian.net/wiki/spaces/IKPubliek/pages/6194398233/Veelgestelde+vragen+Betaalmodule#Wat-is-het-verschil-tussen-een-redirect-URL-en-een-callback-URL

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

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

Dit veld moet minimaal 11 karakters tellen.

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

Dit veld moet minimaal 10 karakters tellen.

String

Indien OraFin -aansluiting EN customerType = KBO: Verplicht veld

Anders: geen verplicht veld

...

Respons

Beschrijving respons

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.

Functionele omschrijving schema’s

...

API

U komt zelf niet in aanraking met de complexiteit van de payment service provider (PSP). Digitaal Vlaanderen interageert met de PSP via de onderstaande API schema’s

...

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

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

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.

Bijvoorbeeld: 7682949223

Dit veld moet minimaal 10 karakters tellen.

String

...