Vent venligst ...


Loading...
Teknisk Dokumentation
Hjemmesider

Subscription webservice

Teknisk dokumentation til subscription webservice

Følgende er en detaljeret beskrivelse af input- og outputværdier til vores subscription webservice, som håndterer abonnementsbetalinger. Du finder subscription webservicen her:

https://ssl.ditonlinebetalingssystem.dk/remote/subscription.asmx

Sådan læses dokumentationen

Hver beskrivelse af en funktion består af input og output. Input er de felter, som webservicen forventer, du sender, når du kalder den. Obligatoriske felter skal sendes med – resten kan du give tomme værdier. Output-felterne er dem, som webservicen returnerer.

Dataflow

1. CreateSubscription – kræver PCI-certificering. Brug i stedet betalingsvinduet eller en betalingsanmodning (ved hjælp af 'Gem betalingskort').

2. Når abonnementet er oprettet, kan du lave normale autorisationer på abonnementet ved at bruge authorize-funktionen. Kortholders betalingskort bliver godkendt og gemt i ePays system, hvorefter betalingen skabes til Nets. Når betalingen er oprettet, skal du behandle den ved at bruge webservicen payment.asmx, som håndterer normale betalinger (hævning, kreditering, sletning). Du kan bruge authorize så ofte du vil, og du kan selv vælge beløbet. 

3. Hvis en kunde ønsker at opsige sit abonnement, skal du kalde deletesubscription, hvorefter ePay sletter abonnementet.

authorize

Input-felterne er de felter, du skal sende med, når du kalder webservicen.

InputTypeVærdierBeskrivelseObligatorisk
merchantnumberInteger7 cifreDit unikke forretningsnummer. Du kan finde det på din indløsningsaftale (f.eks. med Nets).Ja
subscriptionidLong
Det unikke nummer, der identificerer abonnenten.Ja
orderidStringMaks. 20 karakterer. (Nets anbefaler dog, at ordreID'et er på maks. 8 cifre - tal fra 0-9)Ordre-ID'et fra dit eget system. Bruges som reference mellem dit system og ePay.Ja
amount
IntegerAngives i mindste enhederBeløbet i mindste enhender. DKK 125,75 skal f.eks. skrives som 12575.Ja
currency
String208 = DKK 
978 = EUR 
840 = USD
Den valuta, betalingen gennemføres med. Du kan se en komplet liste over valutakoder her.Ja
instantcapture
Integer0 = Manuelt
1 = Automatisk
Ved at sætte denne til 1 hæves betalingen automatisk. Som standard er den sat til 0, og du skal enten hæve betalingen gennem ePay-administrationen eller gennem API/webservice.Ja
group
StringMaks. 100 karakterer.Den gruppe, som betalingen skal tilknyttes.Nej
description
StringMaks. 1024 karakterer.Beskrivelse af betalingen. Beskrivelsen kan ses i din ePay-administration.Nej
email
StringMaks. 100 karakterer.Hvis du angiver en e-mailadresse her, får du en e-mail, når betalingen er autoriseret. Dette felt er IKKE til din kundes ordrebekræftelse.
Nej
sms
StringMaks. 8 karakterer.Hvis du indtaster et mobilnummer her, modtager du en sms med information om betalingen. Det koster DKK 0,25 pr. sms.
Nej
ipaddress
StringMaks. 15 karakterer.Kortholders IP-adresse. Dette bruges til svindelkontrol af Fraud Fighter.
Nej



Her følger beskrivelser af output-felterne, som er dem, webservicen returnerer.

OutputTypeVærdierBeskrivelse
authorizeResultBooleanSe beskrivelsen af output values.
transactionidLongDet unikke nummer, som identificerer betalingen, der returneres ved autorisation.
pbsresponseIntegerHvis Nets afviser hævningen, kan du finde fejlkoden her. Hvis betalingen hæves, er værdien 0.
epayresponseIntegerHvis ePay afviser hævningen, kan du finde fejlkoden i epayresponse.
Output valuesHvis betalingen godkendes, returneres authorizeResult som true. Ellers returneres værdien false. Returneres false, skal epayresponse og pbsresponse bruges til at finde årsagen. Hvis f.eks. denne funktion returnerer false, og epayresponse er (-1) og pbsresponse er 118, betyder det, at Nets afviste betalingen, fordi de ikke genkender kortnummeret. Men hvis funktionen returnerer false, og epayresponse er (-1002), betyder det, at ePay ikke genkender det brugte forretningsnummer.

deletesubscription

Input-felterne er de felter, du skal sende med, når du kalder webservicen.

InputTypeVærdierBeskrivelseObligatorisk
merchantnumberInteger7 cifreDit unikke forretningsnummer. Du kan finde det på din indløsningsaftale (f.eks. med Nets).Ja
subscriptionidLong
Det unikke nummer, der identificerer abonnenten.Ja



Her følger beskrivelser af output-felterne, som er dem, webservicen returnerer.

OutputTypeVærdierBeskrivelse
deletesubscriptionResultBooleanSe beskrivelsen af output values.
epayresponseIntegerHvis ePay afviser sletningen, kan du finde fejlkoden i epayresponse.
Output valuesHvis abonnementet slettes, returneres deletesubscriptionResult som true. Ellers returneres værdien false. Returneres false, skal epayresponse bruges for at finde årsagen til, at abonnementet ikke kunne slettes.

getEpayError

Input-felterne er de felter, du skal sende med, når du kalder webservicen.

InputTypeVærdierBeskrivelseObligatorisk
merchantnumberInteger7 cifreDit unikke forretningsnummer. Du kan finde det på din indløsningsaftale (f.eks. med Nets).Ja
languageInteger1 Sproget, som resultatet returneres på
(1) for dansk
(2) for engelsk
(3) for svensk
Ja
epayresponsecodeInteger
Fejlkoden, du får fra Nets i pbsresponse.Nej



Her følger beskrivelser af output-felterne, som er dem, webservicen returnerer.

OutputTypeVærdierBeskrivelse
getEpayErrorResultBooleanSe beskrivelsen af output values.
epayResponseStringStringFejlen returneres som en string fra ePay.
epayresponseIntegerHvis ePay afviser kaldet, fremgår fejlkoden af epayresponse.
Output valuesHvis det er muligt at få information om fejlkoden, returneres getEpayErrorResult som true. Ellers er den returnerede værdi false. Returneres false, skal epayresponse bruges til at finde årsagen.

getPbsError

Input-felterne er de felter, du skal sende med, når du kalder webservicen.

InputTypeVærdierBeskrivelseObligatorisk
merchantnumberInteger7 cifreDit unikke forretningsnummer. Du kan finde det på din indløsningsaftale (f.eks. med Nets).Ja
languageInteger1 Sproget, som resultatet returneres på
(1) for dansk
(2) for engelsk
(3) for svensk
Ja
pbsresponsecodeInteger
Fejlkoden, du får fra Nets i pbsresponse.Nej



Her følger beskrivelser af output-felterne, som er dem, webservicen returnerer.

OutputTypeVærdierBeskrivelse
getPbsErrorResultBooleanSe beskrivelsen af output values.
pbsResponseStringStringFejlen returneres som en string fra ePay.
epayresponseIntegerHvis ePay afviser kaldet, fremgår fejlkoden af epayresponse.
Output valuesHvis det er muligt at få information om fejlkoden, returneres getPbsErrorResult som true. Ellers er den returnerede værdi false. Returneres false, skal epayresponse bruges til at finde årsagen.

getsubscriptions

Input-felterne er de felter, du skal sende med, når du kalder webservicen.

InputTypeVærdierBeskrivelseObligatorisk
merchantnumberInteger7 cifreDit unikke forretningsnummer. Du kan finde det på din indløsningsaftale (f.eks. med Nets).Ja
subscriptionidLong
Det unikke nummer, der identificerer abonnementet. Hvis denne værdi er sat til 0, returneres alle oprettede og skabte abonnementer. Men hvis værdien er > 0, returneres det enkelte abonnement med dette ID.
Ja

Her følger beskrivelser af output-felterne, som er dem, webservicen returnerer.

OutputTypeVærdierBeskrivelse
getsubscriptionsResultBooleanSe beskrivelsen af output values.
subscriptionAryEt array af typen SubscriptionInformationType. Objektet består af følgende elementer, som er beskrevet nedenfor: subscriptionid, description, created og transactionList, som er et array med gennemførte betalinger på abonnementet.

subscriptionidLongDet unikke nummer, der identificerer abonnementet.
descriptionStringMaks. 1024 karaktererBeskrivelse af betalingen. Beskrivelsen finder du på betalingen i ePay-administrationen.
createdDatetimeTidspunktet, hvor abonnementet blev oprettet.
transactionListTransactionInformationTypeEt array af typen TransactionInformationType. Du kan finde information om den i sektionen: gettransactionlist for normale betalinger.
Output valuesHvis det er muligt at få en liste af abonnementer, returneres funktionen som true. Ellers er den returnerede værdi false. Returneres false, skal epayresponse bruges til at finde årsagen.

Fejlfinding

Alle afvigelser i systemet bliver gemt i en separat log ved ePay, som du kan tilgå fra din ePay-administration. Hvis du oplever problemer med at kalde vores webservice, kan du finde information til fejlretning her.

Loggen findes i ePay-administrationen under menupunktet API/Webservices -> Remote log. Alle fejlkoder findes under Support -> Systemfejlkoder og Support -> Fejlkoder fra PBS.