Documentatie voor klanten en partners van Digitaal Vlaanderen - bouwstenen Mijn Burgerprofiel, Verenigingsloket en e-loketondernemers
Veelgestelde vragen Betaalmodule
- 1 Welke omgevingen zijn er?
- 2 Is mijn ACM ClientId verschillend tussen TNI en Productie?
- 3 Wat moet ik bij ACM aanvragen om toegang te krijgen tot de Betaalmodule API?
- 4 Wat is het verschil tussen een redirect-URL en een callback-URL
- 5 Hoeveel transacties kunnen er gestuurd worden?
- 6 Wat gebeurt er juist als de transactie fout gaat bij de burger (pin nummer niet correct, ontoereikend saldo, aandacht verloren, … Krijgt de applicatie via de callback ook de reden ?
- 7 Komt er altijd een call back na een betaling? Wanneer moet een aansluiter zelf gaan pollen?
- 8 Is de Pom referentie zichtbaar in de CODA file?
Welke omgevingen zijn er?
Test en Integratie (TNI) om te testen en te valideren
Productie voor de live omgeving
Betaalmodule: https://api.betalingen.vlaanderen.be
Is mijn ACM ClientId verschillend tussen TNI en Productie?
Ja, u krijgt steeds een unieke set van sleutels per omgeving.
Wat moet ik bij ACM aanvragen om toegang te krijgen tot de Betaalmodule API?
U vraagt bij ACM een OAuth Client Credentials Grant (CCG) client aan met de scopes dv_mbp_betalingen_betalingen
en vo_info
voor toegang tot de Mijn Burgerprofiel Betalingen API.
Meer informatie: ACM-integratie | Betaalmodule .
Als u al een koppeling maakte met Aanvraagformulieren, is er geen nieuwe ACM-integratie nodig.
Als u al een bestaande ACM OAuth CCG-client heeft, dan kan u ook aan ACM vragen om de scope aan uw bestaande client toe te voegen.
Meer informatie: oAuth REST API voor server-naar-server
De Vlaamse Overheid gebruikt het Vlaams Toegangsbeheer (ACM/IDM) als Identity Provider (IdP). Betaalmodule API's (tenzij anders gedocumenteerd) verwachten bijgevolg overal een Bearer-token in de Authorization request header, zie Vraag Resource op bij de API Resource
Wat is het verschil tussen een redirect-URL en een callback-URL
De redirect-URL toont de gebruiker een pagina nadat de gebruiker betaald heeft
De callback-URL is een technisch endpoint op een server bij de aansluiter waar data naartoe gestuurd wordt als de status van een betaling aangepast wordt.
Meer informatie: Statusupdates van betalingen | Redirect en callback URL’s
Hoeveel transacties kunnen er gestuurd worden?
Om een maximale dienstverlening te kunnen garanderen gebruikt Digitaal Vlaanderen throttling. Bij een overtreding tegen 1 van de 4 onderstaande regels zal Digitaal Vlaanderen een 429 Too Many Requests
response geven:
Maximum calls per domein: 18000 transacties per minuut
Maximum calls per dienst: 2400 transacties per minuut
Maximum calls per afnemer: 1800 transacties per minuut
Maximum calls per afnemer per dienst: 1800 transacties per minuut
Het domein is in deze alles binnen de betaalmodule. Een dienst is gelijk aan 1 API.
Wat gebeurt er juist als de transactie fout gaat bij de burger (pin nummer niet correct, ontoereikend saldo, aandacht verloren, … Krijgt de applicatie via de callback ook de reden ?
De betaling vindt in dit geval niet plaats, en wij zullen van Pom geen completion callback krijgen. Merk op dat dit gedeelte van de betaalflow volledig in de omgeving van Pom gebeurt. De pagina waar de gebruiker zich bevindt, staat niet bij Vlaanderen.
Pom doet wel een poging tot een redirect. Deze redirect gaat naar de URL die in de request is opgegeven, of naar een standaard URL indien deze voor uw tenant is geconfigureerd. Deze redirect bevat een response code van Pom; wij doen daar verder geen interpretaties op. Een response code 00 betekent dat de betaling is gelukt, andere response codes duiden op een falen. Deze afhandeling speelt zich af in de browser en is daarmee louter bedoeld voor schermafhandeling voor de gebruiker. Het is niet de bedoeling om deze statussen in de back-end op te slaan. Het is erg risicovol om back-end statusveranderingen aan het gebruik van de redirect url te verbinden. Statuswijzigingen van een betaling moeten server-to-server (niet via front-end) gebeuren, via de callback url.
De werkelijke statusverandering van een betaling krijgen wij door via een callback, wanneer Pom van de bank een succesvolle callback gekregen heeft. Deze callback krijgen wij alleen als de betaling succesvol was. De betaling krijgt dan status COMPLETED en dit is de enige aanduiding dat een betaling ook daadwerkelijk is verwerkt.
Deze callback bevat daarom geen informatie over eventueel falen.
Komt er altijd een call back na een betaling? Wanneer moet een aansluiter zelf gaan pollen?
Wij reageren op de callback van Pom en kunnen die desgewenst op een callback endpoint aan uw kant posten. Dit gebeurt dus alleen in geval van succesvolle verwerking.
Als uw back-end een call ontvangt op de callback url, dan kan de back-end een nieuwe status komen ophalen bij de betaalmodule.
Het is zinvol om regelmatig een poll uit te voeren, want het is technisch mogelijk dat een push richting callback faalt. Hoe de callback werkt staat hier uitgelegd, samen met de waarom van de nood van het pollen:
Statusupdates van betalingen | Redirect en callback URL’s
Is de Pom referentie zichtbaar in de CODA file?
Dit is nog in onderzoek bij Digitaal Vlaanderen. Op dit moment matchen aansluiters betalingen met mededelingen. Alternatieve vormen van matching worden onderzocht.
Related pages
Dit is een officiële website van de Vlaamse overheid - Uitgegeven door Digitaal Vlaanderen: https://www.vlaanderen.be/digitaal-vlaanderen
DISCLAIMER: http://www.vlaanderen.be/nl/disclaimer
TOEGANKELIJKHEID:
http://www.vlaanderen.be/nl/toegankelijkheid