Betaling toevoegen

Een betaling toevoegen aan het systeem kan op twee manieren. Een HTTP POST-request of met een HTTPGET-request naar api.ideal-service.nl. In dit request zijn een aantal parameters nodig.

Benodigde parameters

Hieronder staan de parameter die nodig zijn om succesvol een betaling toe te voegen.

Parameter	Omschrijving	Type	Controle	Min.lengte	Max.lengte	Verplicht
action	Aangeven dat het om toevoegen gaat	string	moet 'add' zijn			ja
apiKey	API-toegangssleutel	string	geldigheid	1	50	ja
description	Omschrijving betaling	string	alfanummeriek	1	32	ja
reference	Referentie betaling	string	alfanummeriek/uniek	1	32	ja
amount	bedrag in centen	int	nummeriek	min. 0,85	max. 10.000,00	ja
maxpaydate	tot wanneer betaald mag worden	date-string	format(YYYY-MM-DD)	0	10	nee

Resultaat van request

Als u een request gedaan heeft krijgt u ten alle tijden een reactie. De reactie is een JSON-response. Hieronder ziet u een succesvolle response en een foutieve response.

    {"success":true,"paymentId":"owLBqfNphX","paymentLink":"http:\/\/www.ideal-service.nl\/owLBqfNphX"}
    // OF
    {"success":false,"errorCode":"OV0008","errorMessage":"The given reference already exists"}

Parameters die u terug krijgt bij een succesvolle invoer zijn:

Parameter	Type	Omschrijving
success	bool(true)	geeft aan dat de request succesvol is uitgevoerd
paymentId	string	het id van de betaling
paymentLink	string	de rechtstreekse link naar de betaling

Parameters die u terug krijgt bij een foutieve invoer zijn:

Parameter	Type	Omschrijving
success	bool(false)	geeft aan dat de request niet succesvol is
errorCode	string	de code van de foutmelding
errorMessage	string	de omschrijving van de foutmelding

Voorbeeld code

Om de code te gebruiken kunt u zelf uw eigen script schrijven, maar u kunt ook gebruik maken van de class die wij hebben gemaakt voor het gemakkelijk inschieten van betalingen. Deze kunt u hier downloaden.

    require( 'lib/idealPayment.class.php' );

    $apiKey  = 'HIERUWAPISLEUTEL';
    $payment = new idealPayment( $apiKey );
    $response = $payment->addPayment( 'Aankopen bij onze winkel', 'Factuur 2013004', 1595, '2013-12-31' );
    
    echo $response;