Versions Compared

Key

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

...

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 vandaag 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.

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 een de vervaldatum (expirydate) van 30 dagen gelden na de creatie van het betalingsverzoekworden 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

...

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 vandaag 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 een de vervaldatum (expirydate) van 30 dagen gelden na de creatie van het betalingsverzoekworden 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

...