Een betaallink met QR-code aanmaken 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 attributenAttribuut | 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 | amount | Het te betalen bedrag voor het order tot op 2 cijfers na de komma | Decimal, tot op 2 cijfers na de komma | Ja | communication | 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 | 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 attributenAttribuut | 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. | Datum in ISO 8601-formaat, bijv. 2023-05-30) | Neen | communication | 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 | OraFin-aansluiting: nee Geen OraFin-aansluiting: ja | paymentMethod | 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 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. 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, wordt de geldigheidsduur van de betaallink worden overgenomen uit het aansluitingsformulier. | Datum en Tijd in ISO 8601-formaat, UTC tijdzone, bijv. 2023-05-30T07:11:34.542Z | Neen | language | De taal van het betalingsverzoek: 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. 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. bijv.: 82200501055 Dit veld moet minimaal 11 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 |
Mogelijke responsesHieronder een overzicht van de mogelijke responses op de API en de bijhorende beschrijving per respons. Respons | Beschrijving |
|---|
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. | 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. |
De betaling(en) voor een bestelling (order) opmakenU geeft een orderID door. Op basis van dit orderID geeft de betaalback-end van Digitaal Vlaanderen een lijst terug van de bijhorende betaling(en) en informatie over de de status van de betaling. Verplichte attributenAttribuut | Omschrijving | Type |
|---|
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 |
Optionele attributenAttribuut | Omschrijving | Type |
|---|
Limit | Dit veld bevat de paginagrootte van de respons en is standaard ingesteld op 10. | Integer | Offset | Dit veld bevat de pagina-offset van de response, en is standaard ingesteld op 0. | Integer |
Mogelijke responsesHieronder een overzicht van de mogelijke responses op de API en de beschrijving per respons. Respons | Beschrijving |
|---|
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. |
De (online) betaalstatus voor een betaling opvragenU geeft een paymentID door om de bijhorende betaalstatus(sen) op te vragen. De volgende statussen worden opgevraagd: Attribuut | Omschrijving | type? | Verplicht? |
|---|
paymentID | Het paymentID identificeert de betaling zoals gegeven door de Betaalmodule. | String | Ja |
Mogelijke responsesHieronder een overzicht van de mogelijke responses op de API en de beschrijving per respons. 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 APIU 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 Schema: ErrorResponseFoutmelding van de Payment Service Provider die wordt overgenomen in de API van Digitaal Vlaanderen. Attribuut | Omschrijving | Type |
|---|
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 |
Schema: Payment RequestPayment request die de Payment Service Provider ontvangt van de betaalback-end van Digitaal Vlaanderen. Attribuut | Omschrijving | Type |
|---|
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 | 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 na de komma | Decimal, tot op 2 cijfers na de komma | 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 | 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: bijv.: 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. bijv.: 961 Zie ook https://productencatalogus.vlaanderen.be/ | String van 3, 4 of 5 cijfers = IPDC-code | 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. Mogelijke waarden zijn KSZ (voor een particuliere aankoop) of KBO (voor een professionele aankoop). | Enum (KSZ, KBO) | insz | Het rijksregisternummer voor een particuliere aankoop. bijv.: 82200501055 Dit veld moet minimaal 10 karakters tellen. | String van 10 cijfers (RRN), zonder interpunctie | kboNumber | Het KBO-nummer voor een professionele aankoop. bijv.: 7682949223 Dit veld moet minimaal 10 karakters tellen. | String van 10 cijfers (KBO), zonder interpunctie |
Schema: Payment Request ResponseDit is de respons van de PSP op de payment request die Digitaal Vlaanderen creëert op basis van de betaalgegevens (data, orderID,..) en vervolgens doorgeeft aan de PSP. 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 |
|
