Statusupdates van betalingen

1 Presentatie (ter referentie)
2 Flow
3 API
- 3.1 Headers
- 3.2 Technische afspraken
4 Redirect- en callback-URL’s
- 4.1 Redirect vs. callback
- 4.2 Redirect-URL
- 4.3 Callback-URL

Presentatie (ter referentie)

Flow

API

De callback bevat het veld paymentId in het element details. Met dit veld kan bij de Betaalmodule de nieuwe status opgevraagd worden via /api/v1/payments/{paymentId} (zie https://api.betalingen.tni-vlaanderen.be/documentation/swagger-ui/index.html?configUrl=%2Fdocumentation%2Fswagger.json%2Fswagger-config&urls.primaryName=payment#/Betalingsverzoeken/get).

Er wordt een POST met onderstaande body naar het opgegeven endpoint gestuurd:

{
  "eventType": "betaalmodule.paymentCompletion",
  "details": {
    "paymentId": "a80cfb67-8560-444b-9cca-62ca21510768",
    "tenantId": "c041a4fc-5736-478b-a466-424253c5f4df",
    "organisationId": "OVO002949"
  }
}

paymentId: de unieke identifier van de betaling in de Betaalmodule
tenantId: de identificatie van de aansluiting op de Betaalmodule waarvoor het push-bericht gestuurd wordt.
organisationId: de OVO-code van de organisatie waarvoor het push-bericht gestuurd wordt.

Schrijf OVO-code altijd met hoofdletters.

Headers

Volgens de Algemene REST API-specificaties | CorrelationId en RequestId zijn er Correlation en Request headers aanwezig.

X-Correlation-ID: 5cd3f329-fe33-4705-8115-e22638eb0f4f
X-Request-ID: 0b2506d4-14d4-446b-a7a9-3a2944b5efe9

Technische afspraken

We verwachten een 20x response (Vaak zal dit een 200 / 201 / 202 zijn.)

De time-out op de call staat op 10 seconden. De verwerking moet dus binnen deze tijd gebeuren. Er wordt gedurende 8 uur opnieuw geprobeerd.

Redirect- en callback-URL’s

Redirect vs. callback

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.

Redirect-URL

Bij elke payment request kan een redirect-URL worden meegestuurd (optioneel). De klant navigeert na afhandeling van de betaling automatisch naar deze URL. De volgende keuzes zijn beschikbaar:

Een vaste redirect-URL: u kiest zelf een redirect-URL die vast is. Na afhandeling van de betaling navigeert de klant altijd naar de URL van mijn keuze.
Een dynamische redirect-URL: bij elke payment request wordt de redirect-URL meegestuurd. Als de redirect-URL niet wordt meegestuurd, wordt een fallback-URL gebruikt (http://vlaanderen.be )
Geen redirect-URL: u kiest geen redirect-URL. Na afhandeling van de betaling mag de klant op de pagina van de payment service provider (POM) blijven.

Callback-URL

Om op de hoogte te blijven zodra een paymentId is gewijzigd en een betaalstatus is aangepast, kunt u kiezen om een callback-URL te gebruiken (optioneel). De update aan het paymentId wordt dan direct naar de callback-URL gestuurd.

Documentatie voor partners en klanten van Digitaal Vlaanderen - bouwstenen Mijn Burgerprofiel, Verenigingsloket en e-loketondernemers

Documentatie voor klanten en partners van Digitaal Vlaanderen - bouwstenen Mijn Burgerprofiel, Verenigingsloket en e-loketondernemers