Implementatie documentatie en voorbeeldcode telefonisch betalen

Op deze pagina staat een korte beschijving over hoe het micropayment systeeem geïntegreerd kan worden in je website. Enige kennis van PHP/HTML en XML is hierbij een pre.

We gaan eerst een korte beschrijving geven van de werking van het systeem.

• Stap 1:
  Wanneer een klant toegang wil tot een deel van je website waarvoor betaald moet worden, zal er vanaf je website een aanvraag gedaan moeten worden bij ons micropayment systemen.
• Stap 2:
  Als reactie op deze aanvraag genereert ons systeem een code voor je klant.
• Stap 3:
  De code en het te bellen telefoon nummer wordt terug gezonden naar je website, die er vervolgens voor zorgt dat de code en het telefoonnummer aan je klant getoond kan worden.
• Stap 4:
  De klant belt het telefoonnummer, toets de code in en krijgt de melding dat de betaling is verwerkt en klikt op een 'ik heb betaald' knop op jouw website.
• Stap 5:
  Je website verifieert bij onze systemen of de betaling daadwerkelijk verwerkt is en geeft de klant toegang tot het betaalde gedeelte van jouw website.

Verder is het nog van belang te weten dat er verschillende vormen zijn van betalen, namelijk pay per call (PPC), pay per minute (PPM) en pay while call (PWC), een beschijving van deze betaalvormen is te vinden op deze website. Hieronder kun je de volledige implementatiedocumentatie en voorbeeldcode downloaden.

Download de volledige implementatiedocumentatie (pdf).

Download de voorbeeldcode (zip).
Let op: deze code is geschreven met sessies en in php.

We gaan hieronder verder met een bondige uitleg over de technische werking van het systeem.

Ophalen van een betaalcode

De communicatie tussen je website en onze systemen verloopt via de HTTP post methode en XML. De communicatie als beschreven bij stap 1 gaat via de post methode en heeft het volgende format:

Een aantal van deze velden zijn verplicht namelijk: action, siteid en amount.
Action=get geeft aan dat het om het aanvragen van de betalingsgegevens gaat.
Siteid is het unieke programmaid wat je hebt aangemaakt op deze website onder programma’s beheren.
Amount is de hoogte van het te betalen bedrag.

Voor een omschrijving van de overige velden verwijzen we je graag naar de uitgebreide documentatie.

De reactie als beschreven in stap 3 is een bericht in XML format.

Een aantal velden uit dit bericht dien je aan je klant te tonen, zodat deze een betaling kan doen. Als eerste het servicenumber, het telefoonnummer wat de klant moet bellen om een betaling te doen. Ten tweede de code, de betaalcode die ingevoerd moet gaan worden nadat het servicenummer is gebeld.

De geldeenheid (valuta) van de betaling staat in het currency veld. Deze kun je samen met amount, het te betalen bedrag, vermelden. Ook is het dan van belang om te vermelden wat de methode van betalen is, dit wordt omschreven in het method veld.

Priceperunit zijn de kosten per gesprek (PPC) of de kosten per minuut (bij PPM of PWC) voor het bellen naar het servicenummer. Deze dien je in Nederland te vermelden bij het 0900-nummer.

Verder kan je de duration van het gesprek vermelden. Dit is alleen van belang wanneer het gaat om PPM of PWC. Zo weet de klant hoelang het gesprek moet duren voordat de betaling voldaan is.

Mocht er iets mis gaan in de communicatie dan zal dat verteld worden in het errormsg veld.
Een volledige beschrijving van alle velden kun je vinden in onze uitgebreide documentatie.

Controleren van een betaling

Om te controleren of een betaling daadwerkelijk is voldaan (als beschreven bij stap 5) zal er vanaf je website een controle bericht verzonden moeten worden naar onze systemen. Dit gaat ook via een HTTP post request (net als bij het ophalen van een code) met het volgende formaat:

Action=check vertelt ons systeem dat het gaat om het controleren of de code is betaald. Om dat te kunnen controleren zijn er een aantal velden verplicht. siteid is wederom het unieke programmaid wat je hebt aangemaakt op deze website. code is de betaalcode die gecontroleerd moet worden. Als het goed is heeft de bezoeker van je website die ingevoerd, waarmee de betaling afgerond is. Bij het aanvragen van een code wordt een supplierpaymentid teruggegeven. Dezelfde supplierpaymentid dien je bij de controle wederom mee te sturen. Method geeft de methode van betalen aan. Ook deze dient gelijk te zijn aan de bij aanvraag verkregen method.

Het enige niet verplichte veld is paymentid, dit is een vrij in te vullen veld. Deze kan je gebruiken om een eigen kenmerk mee te geven aan een betaling.

De reactie op deze aanvraag is ook een in XML bericht in het volgende formaat:

Het veld duration geeft de status van de betaling weer.

De betaling is voldaan wanneer de duration groter of gelijk is aan de waarde van het duration veld wat verkregen is bij de aanvraag van een code. Let op: bij PPC kan het zijn dat iemand twee keer moet bellen naar een 0900-nummer om de betaling te voldoen. Dan is de waarde 2.

Bij PWC kun je controleren op het active veld om te bepalen of de klant op dit moment een verbinding heeft met onze systemen.