Pay Per Minute
Start
U kunt een Pay Per Minute transactie starten via de functie DoPayPerMinuteRequest(). Hierbij geeft u een ProductTypeID mee. Daarmee geeft u aan wat de aard is van het
product. Uw keuze hier bepaalt wat voor telefoonnummer u kunt gebruiken. In Nederland is er bijvoorbeeld keuze uit 0900(informatiediensten), 0906(erotiek) en
0909(entertainment).
Bij de aanroep kunt u ook een reference meegeven.
Deze reference wordt door PremiumXS gebruikt bij het geven van de terugkoppeling en terugsturen van de klant naar uw website.
Met de reference kunt u de transactie dan binnen uw eigen systeem herkennen.
In het antwoord dat u ontvangt staat een telefoonnummer, een tariefmelding en een code. Deze kunt u aan de klant weergeven. De klant kan dan naar het opgegeven
telefoonnummer bellen. De code bestaat uit vier of vijf cijfers(vijf cijferige codes worden alleen gebruikt als het erg druk is).
Nadat de klant heeft ingebeld wordt deze verzocht de code in te toetsen en af te sluiten met een hekje(#). Wanneer de code is geaccepteerd ontvangt u een eerste
terugkoppeling op de door u opgegeven statusURL. Hierin staat de statuscode '210'. Dit betekent dat het gesprek is gestart. U kunt nu uw dienst vrijgegeven
voor gebruik. U kunt de klant herkennen aan de door u opgegeven reference. Deze staat namelijk in elke terugkoppeling die u ontvangt.
Afsluiten
Nadat de klant heeft opgehangen ontvangt u een nieuwe terugkoppeling. Hierin staat de statuscode '211'. Dit betekent dat het gesprek is beëindigd. U kunt nu
de dienst stopzetten. Daarnaast bevat de terugkoppeling het aantal seconden dat de klant heeft gebeld. Deze kunt u gebruiken voor uw eigen administratie. Deze informatie
kunt u ook terugvinden in uw statistieken bij PremiumXS.
Functieoverzicht
DoPayPerMinuteRequest() Aanroep
| Parameter |
Beschrijving |
Type |
Max. Lengte |
|
CustomerID
|
Unieke identificatie voor gebruik API
|
String
|
42 karakters
|
|
paymentProfileID
|
In een PaymentProfile staan verschikllende betaalmethoden geconfigureerd. U kunt standaard de volgende waarden gebruiken:
1: Standaard
3: Test(alleen voor PremiumRate)
|
Integer
|
-
|
|
Reference
|
Uw eigen kenmerk. Wordt ook gebruikt bij de terugkoppeling en het terugsturen van de klant naar uw website.
|
String
|
64 karakters
|
|
productCode
|
Hier kunt u zelf een waarde opgeven. Deze waarde wordt later gebruikt bij het genereren van statistieken.
|
String
|
16 karakters
|
|
productDescription
|
Beschrijving van het product dat afgerekend wordt. Komt later ook op het bankafschrift.
|
String
|
128 karakters
|
|
productTypeID
|
Geeft hiermee de aard van het product aan. U kunt kiezen uit de volgende waarden:
- Standaard
- Erotiek
- Entertainment
|
Integer
|
-
|
|
ipAddress
|
Het IP-adres van de klant.
|
String
|
15 karakters
|
|
countryCode
|
Het land waarin de klant zich bevindt.
|
String
|
2 karakters
|
|
statusURL
|
URL waarnaar de terugkoppeling wordt verzonden. Als u geen terugekoppeling wilt ontvangen kunt u dit veld leeglaten.
|
String
|
512 karakters
|
DoPayPerMinuteRequest() Antwoord
| Parameter |
Beschrijving |
Type |
Max. Lengte |
| status |
Resultaat van de aanvraag. De waarde 'OK' betekent dat de transactie gestart is. Indien dit niet zo is staat hier de reden. |
String |
512 karakters |
| statusCode |
Code die het resultaat van de aanvraag bepaalt. Code '0' betekent dat de transactie gestart is. Anders staat hier een foutcode. |
Integer |
- |
|
transactionID
|
Uniek kenmerk dat door PremiumXS aan de transactie wordt gekoppeld. Wordt ook gebruikt bij de terugkoppeling en het terugsturen van de klant
naar uw website.
|
GUID
|
-
|
|
premiumRateNumber
|
Het betaalnummer waarnaar de klant moet bellen.
|
String
|
32 karakters
|
|
tariffMessage
|
De kosten per minuut voor het bellen naar het betaalnummer. U bent verplicht deze samen met het telefoonnummer weer te geven.
|
String
|
128 karakters
|
|
pincode
|
De code die klant in moet toetsen op de telefoon nadat het betaalnummer is gebeld.
|
Integer
|
1000 - 99999
|
|
callDuration
|
Het aantal seconden dat nodig is voor het gesprek. Bij PayPerMinute is dit onbekend en daarom staat hier de waarde -1.
|
Integer
|
-
|