Start transactie bij PremiumXS
Voor het opstarten van de transactie maakt u gebruik van de functie DoPayformRequest().
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.
De productbeschrijving die u meegeeft onder de parameter productDescription wordt getoond aan de klant. Ook is de door u opgegeven siteName te zien in het betaalscherm.
Nadat u de transactie hebt gestart ontvangt u van PremiumXS een forwardURL. Hiernaartoe kunt u uw klant doorsturen.
U kunt dit in hetzelfde browserwindow doen of in een nieuw venster/tabblad.
Het verdient de aanbeveling het doorsturen in hetzelfde browserwindow te doen.
Functie overzicht
DoPayformRequest() 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
|
-
|
|
predefinedOptionID
|
U kunt bepaalde betaalmethoden uitzetten. Dit doet u via uw account op www.premiumxs.nl. U ontvangt dan een predefinedOptionID voor de
gekozen instellingen. Deze kunt u hier invullen.
Wanneer u hier geen gebruik van maakt vult u de waarde 0 of -1 in.
|
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. Wordt in het betaalscherm weergegeven. Komt later ook op het bankafschrift bij gebruik van iDeal.
|
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
|
|
Price
|
Het bedrag dat u af wilt laten rekenen.
|
Decimal
|
-
|
|
Currency
|
De munteenheid van het bedrag dat u wilt laten afrekenen.
|
String
|
3 karakters
|
|
siteName
|
De naam van uw website. Vul hier bij voorkeur de URL in van uw hoofdpagina, bijvoorbeeld www.mijn-pagina.nl.
|
String
|
64 karakters
|
|
paymentScreenID
|
Hiermee bepaalt u het uiterlijk van het betaalscherm. U kunt kiezen uit de volgende waarden:
1. Standaardbetaalscherm
25. Betaalscherm voor mobiele gebruikers
|
Integer
|
-
|
|
statusURL
|
URL waarnaar de terugkoppeling wordt verzonden. Als u geen terugekoppeling wilt ontvangen kunt u dit veld leeglaten.
|
String
|
512 karakters
|
|
returnURL
|
Naar deze URL wordt de klant doorgestuurd nadat de betaling succesvol is afgerond.
Aan deze URL wordt een querystring toegevoegd met daarin de parameters reference(uw eigen kenmerk) en id(het door PremiumXS aan de transactie toegekende kenmerk).
|
String
|
512 karakters
|
|
cancelURL
|
Naar deze URL wordt de klant doorgestuurd nadat de betaling mislukt is of wanneer deze is afgebroken.
Aan deze URL wordt een querystring toegevoegd met daarin de parameters reference(uw eigen kenmerk) en id(het door PremiumXS aan de transactie toegekende kenmerk).
|
String
|
512 karakters
|
DoPayformRequest() 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
|
-
|
|
forwardURL
|
De URL van het betaalscherm. Hiernaartoe kunt u uw gebruiker doorsturen.
|
String
|
512 karakters
|