iDEAL API

Met de HTTP API voor Betaling starten kunt u betalingen starten en de status ervan controleren. Gebruik de HTTP API wanneer u verzoeken wilt sturen naar DigiWallet vanuit uw shop of app en als de DigiWallet PHP SDK niet gebruikt kan worden.

Afrekenen in 2 stappen:

  1. Start de betaling bij DigiWallet door een URL aan te roepen met alle kenmerken van de betaling. DigiWallet geeft een link naar de bank en het transactienummer (Start API) ;
  2. De status van de betaling wordt doorgemeld en de bezoeker teruggestuurd naar uw site. U kunt met de "Check API" de status van de betaling controleren (Check API) ;

Bankenlijst opvragen

Tijdens het starten van de betaling kunt u de bank van de consument meegeven. Deze stap is optioneel. Als u de bank parameter weglaat uit de Start API aanroep, zal DigiWallet de consument een bankselectie scherm tonen.

In het geval u liever de bankselectie in u eigen website integreert, kunt u de consument hun bank laten selecteren uit een pulldown menu. Een dynamisch pulldown menu met bankenlijst kunt u als volgt opnemen:

<form name="bankselect"><select name=bank onChange="document.bankselect.submit();"><?php readfile("https://transaction.digiwallet.nl/ideal/getissuers?ver=4&format=html"); ?></select></form>

Voorbeeld

Mocht het dynamische pull down menu niet werken voor u, dan kunt u ook een XML opvragen met de bankenlijst :

https://transaction.digiwallet.nl/ideal/getissuers?ver=4&format=xml

Start API Betaling starten

Voor het starten van de betaling roept u de Start API aan. Van de Start API krijgt u de betaallink om uw klant door te verwijzen en het transactienummer (voor in uw database).

Roep de volgende URL aan met GET of POST:

https://transaction.digiwallet.nl/ideal/start

Met de volgende parameters (* = verplicht):

Variabele Toelichting Voorbeeld
ver* API versie, dit is versie 4 4
rtlo* Shop ID (ook wel subaccount of layoutcode) waarop de betaling geboekt moet worden 93393
bank Bank code: gekozen door de consument in de vorige stap
Merk op dat als deze parameter weggelaten wordt, DigiWallet de klant eerst haar eigen bankselectie scherm laat zien alvorens hen door te sturen naar de bank.
KNABNL2H
amount* Bedrag in eurocenten: Minimaal 84 , Maximaal 1000000 1000
description* Omschrijving van de transactie: dit wordt op het bankafschrift van de klant vermeld. Gebruik alleen letters of cijfers, max. 32 tekens Webshop order #1234
reporturl Report URL: wordt aangeroepen na betaling (van server naar server) door middel van een POST. Controleer hier of de betaling inderdaad is afgerond en verwerk de bestelling verder. Dit script wordt ook aangeroepen als de klant de browser per ongeluk zou sluiten. Als parameters worden meegestuurd:
  • trxid: bestelnummer
  • idealtrxid: iDEAL bestelnummer
  • rtlo: shop ID (layoutcode)
  • status: status-code van de betaling, zie Check API
  • cname: naam van de klant, mits de betaling gelukt is
  • cbank: IBAN nummer van klant, mits betaling gelukt is
Om te zekeren dat de status terugmelding van DigiWallet afkomt, dient u altijd de Check API . De output van de report URL zal niet zichtbaar zijn voor de klant. De klant wordt doorgestuurd naar de return- of cancel URL.
https://www.myshop.nl /reportOrder
returnurl* Return URL: naar deze pagina wordt uw klant verwezen na een (succesvolle) betaling. Aan deze URL wordt het transactienummer in de variabele trxid meegegeven.
Voorbeeld: https://www.myshop.nl/thankYouPage?trxid=30626804185492
https://www.myshop.nl /thankYouPage
cancelurl Cancel URL: de URL waar de bezoeker naar toe wordt gestuurd na het afbreken van de betaling. Als deze niet ingevuld is, dan wordt na een afgebroken betaling naar de return URL verwezen. https://www.myshop.nl /orderCancelled
userip IP adres van de klant. 213.76.8.33
test Bepaalt of het DigiWallet Test Paneel moet worden gebruikt.
Wanneer geactiveerd zal de launch URL een link naar het Test Paneel worden, waar geen echt geld verrekend kan worden.
Merk op dat als uw outlet in test-modus is gezet via het DigiWallet Dashboard, deze parameter automatisch op 1 komt te staan.

Vergeet deze optie niet uit te zetten als de site live gaat. Standaard staat testmode uit.
"1" of "0"
preprodtest Bepaalt of de acquirer test omgeving moet worden gebruikt, in plaats van het DigiWallet Test Paneel.
Bij het gebruiken van de testverbinding wordt er geen echt geld afgeschreven. Als u dit op 1 zet zal dat ook de "test" parameter automatisch op 1 zetten.
"1" of "0"


U krijgt vervolgens een resultaat als volgt:

resultaatcode   transactienummer | bank-url

Voorbeeld

000000 103084|https://pay.digiwallet.nl/consumer/ideal/launch/103084/da85a5e0-b29e-11e8-9332-ecf4cbbfde30/0
U kunt vervolgens het transactienummer opslaan in uw database en de bezoeker doorsturen naar de bank-url door middel van een redirect.


Mogelijke resultaatcodes:

Resultaatcode Omschrijving
000000 Betaling is klaargezet
DW_XE_0003 Validation failed, details: JSON-encoded array Één of meer velden konden niet gevalideerd worden. U kunt de JSON array decoderen voor een gedetailleerde analyse.
DW_IE_0002 Maximum retries at acquirer bank exceeded for primary and fallback Het acquirer systeem reageerde meermaals op rij niet, wat aangeeft dat er misschien een storing gaande is.
DW_IE_0006 System is busy, please retry later Interne systemen zijn overbelast en DigiWallet is hoogstwaarschijnlijk al bezig met het probleem op te lossen.
DW_IE_0001 Unknown internal error Onbekende interne foutmelding. Mail naar techsupport@targetmedia.eu voor ondersteuning.

Controleer in geval van fouten of de parameters goed zijn overgenomen uit de documentatie. Als dit het geval lijkt te zijn, neem dan contact op met DigiWallet. Vermeldt de aanroep en de foutmelding.

Check API Status van een betaling opvragen


Aan de hand van het transactienummer kunt u controleren of de betaling daadwerkelijk is gedaan. Na de betaling wordt de report URL onder water aangeroepen door de DigiWallet server. Hierbij wordt ook de betaalstatus vermeld, maar we adviseren om veiligheidsredenen altijd zelf de status nog op te vragen bij DigiWallet.

Roep de volgende URL aan met een GET of POST:

https://transaction.digiwallet.nl/ideal/check

Met de volgende parameters (* = verplicht):

Variabele Toelichting Voorbeeld
rtlo* Shop ID (layoutcode) 93393
trxid* transactienummer 30626804185492
test Als u de transactie in test-modus hebt gestart, roep de Check API dan ook aan in test-modus. Als u dit niet doet zal uw transactie niet gevonden worden.

Merk op dat als uw outlet in test-modus is gezet via het DigiWallet Dashboard, deze parameter automatisch op 1 komt te staan.

Vergeet deze optie niet uit te zetten als de site live gaat. Standaard staat testmode uit.
1
once* Als u 1 invult, dan zal slechts eenmaal een OK status teruggegeven worden. Als de bovenstaande URL nog een keer wordt aangeroepen voor dezelfde transactie, dan volgt een melding DW_SE_0028 Transaction already checked. Als u voor once '0' invult, dan zal steeds een 000000 OK status terug blijven komen. 0


Als de betaling met succes afgerond is, ontvangt u als antwoord :

000000 OK


Als de betaling nog niet is afgerond of de transactie is niet bekend :

Foutcode Omschrijving
DW_SE_0020 Transaction has not been completed, try again later Transactie is nog niet afgerond, probeer het later opnieuw
DW_SE_0021 Transaction has been cancelled Transactie is geannuleerd
DW_SE_0022 Transaction has expired Transactie is verlopen (max. 10 minuten)
DW_SE_0023 Transaction could not be processed De transactie kon niet verwerkt worden
DW_SE_0028 Transaction already checked at datetime Reeds ingewisseld
DW_XE_0003 Validation failed, details: JSON-encoded array Één of meer velden konden niet gevalideerd worden. U kunt de JSON array decoderen voor een gedetailleerde analyse.
DW_IE_0002 Maximum retries at acquirer bank exceeded for primary and fallback Het acquirer systeem reageerde meermaals op rij niet, wat aangeeft dat er misschien een storing gaande is.
DW_IE_0006 System is busy, please retry later Interne systemen zijn overbelast en DigiWallet is hoogstwaarschijnlijk al bezig met het probleem op te lossen.
DW_IE_0001 Unknown internal error Onbekende interne foutmelding. Mail naar techsupport@targetmedia.eu voor ondersteuning.

Als u een oudere versie van de API gebruikt, dan komen sommige transactie status resultaten terug in een legacy formaat:

Foutcode Omschrijving
TP0010 Transaction has not been completed, try again later Transactie is nog niet afgerond, probeer het later opnieuw
TP0011 Transaction has been cancelled Transactie is geannuleerd
TP0012 Transaction has expired Transactie is verlopen (max. 10 minuten)
TP0013 The transaction could not be processed De transactie kon niet verwerkt worden
TP0014 Already used Reeds ingewisseld



Beschikbaar in plugins

This paymethod is supported in the following plugins: