PayPal 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:
- 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) ;
- 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) ;
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/paypal/start
Met de volgende parameters (* = verplicht):
Variabele | Toelichting | Voorbeeld |
---|---|---|
ver* | API versie, dit is versie 1 | 1 |
rtlo* | Shop ID (ook wel subaccount of layoutcode) waarop de betaling geboekt moet worden | 93393 |
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:
|
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. |
https://www.myshop.nl /orderCancelled |
country |
Landcode volgens ISO
3166-1
Standaardwaarde is: NL
|
NL |
currency |
Valutacode volgens ISO
4217
Standaardwaarde is: EUR
|
EUR |
userip | IP adres van de klant. | 213.76.8.33 |
Email adres van de consument. | test@example.com | |
test |
Of de test-modus moet worden gebruikt. Merk op dat de test-modus nog steeds een transactie met echt geld betreft, maar deze hoeft niet succesvol afgerond te worden om een success melding te krijgen van de Check API. |
"1" of "0" |
U krijgt vervolgens een resultaat als volgt:
resultaatcode
transactienummer
|
bank-url
Voorbeeld
000000 PAY-XXXXXXXXXXXXXXXXXXXXXXXX|https://www.paypal.com/cgi-bin/webscr?cmd=_express-checkout&token=EC-XYXYXYXYXYXYXYXYX
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_SE_0029 No contract on this layoutcode | Er is of geen contract op deze layoutcode of het is niet actief, mail naar sales@targetmedia.eu |
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_0001 Unknown internal error | Onbekende interne foutmelding. Mail naar techsupport@targetmedia.eu voor ondersteuning |
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/paypal/check
Met de volgende parameters (* = verplicht):
Variabele | Toelichting | Voorbeeld |
---|---|---|
rtlo* | Shop ID (layoutcode) | 93393 |
trxid* | transactienummer | 30626804185492 |
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_0023 Transaction could not be processed | De transactie kon niet verwerkt worden |
DW_IE_0001 Unknown internal error | Onbekende interne foutmelding. Mail naar techsupport@targetmedia.eu voor ondersteuning |
Beschikbaar in plugins
This paymethod is supported in the following plugins: