Vent venligst ...


Loading...
Teknisk Dokumentation
Hjemmesider

API til Betalingsanmodninger

Beskrivelse af webservice til betalingsanmodninger

En betalingsanmodning er et link, som åbner betalingsvinduet. Linket kan f.eks. sættes i en e-mail, så du kan sende en e-mail direkte til en kunde, som skal betale et beløb til dig.

Denne sektion gennemgår vores API til betalingsanmodninger. Alle funktioner, metoder og input- og outputværdier er beskrevet her.

Du kan finde vores webservice til betalingsanmodninger her:

https://paymentrequest.api.epay.eu/v1/

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.

Betalingsanmodningens trin

Normalt vil en betalingsanmodning gå igennem følgende trin.

  • Trin 1

    Du opretter betalingsanmodningen med createpaymentrequest.

    Bemærk:
    Hvis du vil tilføje formularer på betalingsanmodningen, skal du først kalde createform og derefter knytte det formid, som du får tilbage, til din betalingsanmodningen ved at sende det med som en parameter til createpaymentrequest

  • Trin 2

    Du kan sende betalingsanmodningen til kunden med sendpaymentrequest, eller du kan sende det link, som du får tilbage fra createpaymentrequest, til kunden på anden vis.

  • Trin 3

    Kunden gennemfører betalingen.

  • Trin 4

    Betalingens transaktionsnummer (transactionid) knyttes automatisk til betalingsanmodningens ID (paymentrequestid), hvis du bruger vores betalingsvindue eller sender linket direkte til kunden. Du kan så bruge gettransaction til at se de transaktioner, der er gennemført på en betalingsanmodning.

    Hvis du bruger en anden metode, kan du bruge addtransaction til at knytte transaktionsnummeret til betalingsanmodningens ID.

Metoder til paymentrequest

Det følgende beskriver metoderne til håndtering af betalingsanmodninger.

createpaymentrequest

createpaymentrequest opretter en betalingsanmodning.

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

InputTypeObjektTypeVærdierBeskrivelseObligatorisk
merchantnumberStringauthenticationDit unikke forretningsnummer. Du kan finde det på din indløsningsaftale (f.eks. med Nets).Ja
passwordStringauthenticationDit kodeord. Du kan finde det på din epay-konto.Ja
referenceStringpaymentrequestReferencenavn til betalings-anmodningen. Dette er en reference (eller et ID), som du selv tildeler og sender med.Ja
exactclosedateDatetimetransactionVælg en dato, hvor betaling-sanmodningen skal lukke.Nej
closeafterxpaymentsIntegertransactionAngiv det antal betalinger, der må køres igennem, inden betalings-anmodningen lukkes.Nej
Du kan tilføje parametre til betalingsanmodningen - klik her for at se alle parametre (JSON body).
Den tekniske dokumentation til parametre findes her.
parameters
languageStringAngiv, hvilket sprog du vil modtage fejlbeskeder på.Nej
localtimezoneBooleanTrue/falseTrue = lokaltidNej

Her følger beskrivelser af output-felterne, som er dem, API'et returnerer.

OutputTypeVærdierBeskrivelse
paymentrequestidLongDet unikke nummer, der identificerer den oprettede betalingsanmodning.
key (paymentrequest)StringNøgle, som bruges til at finde betalingsanmodningen. Det er en sikkerhed, så betalingsanmodninger ikke kan findes på paymentrequestid alene.
link (paymentrequest)StringURL til betalingsanmodningen
resultBooleanSe beskrivelsen af output values.
messageStringHvis result er false, vil message vise en detaljeret fejlbesked.
reasonEnum
requestresponselogidLongDenne medtages kun på testkonto, eller hvis der er opstået en fejl på produktionskontoen (result er false).
Output valuesHvis kaldet er en succes, returneres result som true. Ellers er den returnerede værdi false. Returneres false, bruges message til at finde fejlårsagen.

getpaymentrequest

getpaymentrequest henter informationer om en betalingsanmodning baseret på paymentrequestid.

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

InputTypeObjektTypeVærdierBeskrivelseObligatorisk
merchantnumberStringauthenticationDit unikke forretningsnummer. Du kan finde det på din indløsningsaftale (f.eks. med Nets).Ja
passwordStringauthenticationDit kodeord. Du kan finde det på din epay-konto.Ja
paymentrequestidLongpaymentrequestDet unikke nummer, der identificerer betalingsanmodningen. 
Ja
languageStringAngiv, hvilket sprog du vil modtage fejlbeskeder på.Nej
localtimezoneBooleanTrue/falseTrue = lokaltidNej

Her følger beskrivelser af output-felterne, som er dem, API'et returnerer.

OutputTypeVærdierBeskrivelse
closeafterxpayments (paymentrequest)IntegerDin angivelse af, hvor mange betalinger der må gennemføres, inden betalingsanmodningen lukkes.
exactclosedate (paymentrequest)DatetimeDen dato, hvor betalingsanmodningen lukker.
key (paymentrequest)StringNøgle, som bruges til at finde betalingsanmodningen. Det er en sikkerhed, så betalingsanmodninger ikke kan findes på paymentrequestid alene.
link (paymentrequest)StringURL til betalingsanmodningen
referenceStringReferencenavn til betalingsanmodningen
statusEnum1 = Åben
2 = Lukket
3 = Arkiveret

parameters - klik her for at se alle parametre (JSON body).
Den tekniske dokumentation til parametre findes her.


resultBooleanSe beskrivelsen af output values.
messageStringHvis result er false, vil message vise en detaljeret fejlbesked.
reasonEnum
requestresponselogidLongDenne medtages kun på testkonto, eller hvis der er opstået en fejl på produktionskontoen (result er false).
Output valuesHvis kaldet er en succes, returneres result som true. Ellers er den returnerede værdi false. Returneres false, bruges message til at finde fejlårsagen.

listpaymentrequest

listpaymentrequest henter en liste med informationer om betalingsanmodninger.

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

InputTypeObjektTypeVærdierBeskrivelseObligatorisk
merchantnumberStringauthenticationDit unikke forretningsnummer. Du kan finde det på din indløsningsaftale (f.eks. med Nets).Ja
passwordStringauthenticationDit kodeord. Du kan finde det på din epay-konto.Ja
sortingEnumsorting0 = stigende
1 = faldende
Angiv, hvilken sortering der anvendes på listen ud fra oprettelsesdatoen. Nej
exclusivestartkeyLongpagingDet paymentrequestid, hvorfra udtrækket skal starte. 
Bemærk! Denne medtages ikke i udtrækket.
Nej
pagesizeIntegerpaging20-100Størrelsen på den liste, der hentes. Nej
languageStringAngiv, hvilket sprog du vil modtage fejlbeskeder på.Nej
localtimezoneBooleanTrue/falseTrue = lokaltidNej

Her følger beskrivelser af output-felterne, som er dem, API'et returnerer.

OutputTypeVærdierBeskrivelse
paymentrequestid (paymentrequestlist)LongDet unikke nummer, der identificerer betalingen.
amount (transactionlist)InteherBetalingsanmodningens beløb
created (transactionlist)DatetimeOprettelsesdato
currency (transactionlist)StringBetalingsanmodningens valuta
numberoftransactions (transactionlist)IntegerAntal transaktioner på betalingsanmodningen
key (transactionlist)String
Nøgle, som bruges til at finde betalingsanmodningen. Det er en sikkerhed, så betalingsanmodninger ikke kan findes på paymentrequestid alene.
link (transactionlist)String
URL til betalingsanmodningen
reference (transactionlist)String
Referencenavn til betalingsanmodningen
pagesize (paging)Integer
Størrelsen på den liste, der hentes.
lastevaluatedkeyLong
Det transactionid, som sidst er tilføjet listen.
resultBooleanSe beskrivelsen af output values.
messageStringHvis result er false, vil message vise en detaljeret fejlbesked.
reasonEnum0 = OK
1 = Error
requestresponselogidLongDenne medtages kun på testkonto, eller hvis der er opstået en fejl på produktionskontoen (result er false).
Output valuesHvis kaldet er en succes, returneres result som true. Ellers er den returnerede værdi false. Returneres false, bruges message til at finde fejlårsagen.

deletepaymentrequest

deletepaymentrequest sletter betalingsanmodningen.

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

InputTypeObjektTypeVærdierBeskrivelseObligatorisk
merchantnumberStringauthenticationDit unikke forretningsnummer. Du kan finde det på din indløsningsaftale (f.eks. med Nets).Ja
passwordStringauthenticationDit kodeord. Du kan finde det på din epay-konto.Ja
paymentrequestidLongpaymentrequestDet unikke nummer, der identificerer betalingsanmodningen. Ja

Her følger beskrivelser af output-felterne, som er dem, API'et returnerer.

OutputTypeVærdierBeskrivelse
resultBooleanSe beskrivelsen af output values.
messageStringHvis result er false, vil message vise en detaljeret fejlbesked.
reasonEnum0 = OK
1 = Error

requestresponselogidLongDenne medtages kun på testkonto, eller hvis der er opstået en fejl på produktionskontoen (result er false).
Output valuesHvis kaldet er en succes, returneres result som true. Ellers er den returnerede værdi false. Returneres false, bruges message til at finde fejlårsagen.

sendpaymentrequest

sendpaymentrequest afsender betalingsanmodningen.

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

InputTypeObjektTypeVærdierBeskrivelseObligatorisk
merchantnumberStringauthenticationDit unikke forretningsnummer. Du kan finde det på din indløsningsaftale (f.eks. med Nets).Ja
passwordStringauthenticationDit kodeord. Du kan finde det på din epay-konto.Ja
nameStringrecipient
Navnet på modtageren af betalingsanmodningenJa
emailaddressStringrecipientValid email
E-mailadressen på modtageren af betalingsanmodningenJa
requesterStringemail
Angiv for at få mulighed for at tilføje afsendernavn i mailen, der sendes ud.Nej
commentStringemail
Angiv for at få mulighed for at tilføje et kommentarfelt i mailen, der sendes ud.
Nej
nameStringreplyto
Angiv et navn, som bruges ved besvarelse af betalingsanmodningen.Nej
emailaddressStringreplytoValid emailAngiv en e-mailadresse, som bruges ved besvarelse af betalingsanmodningen.Nej
paymentrequestidLongpaymentrequestDet unikke nummer, der identificerer betalingsanmodningen. Ja

Her følger beskrivelser af output-felterne, som er dem, API'et returnerer.

OutputTypeVærdierBeskrivelse
resultBooleanSe beskrivelsen af output values.
messageStringHvis result er false, vil message vise en detaljeret fejlbesked.
reasonEnum0 = OK
1 = Error

requestresponselogidLongDenne medtages kun på testkonto, eller hvis der er opstået en fejl på produktionskontoen (result er false).
Output valuesHvis kaldet er en succes, returneres result som true. Ellers er den returnerede værdi false. Returneres false, bruges message til at finde fejlårsagen.

closepaymentrequest

closepaymentrequest lukker betalingsanmodningen.

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

InputTypeObjektTypeVærdierBeskrivelseObligatorisk
merchantnumberStringauthenticationDit unikke forretningsnummer. Du kan finde det på din indløsningsaftale (f.eks. med Nets).Ja
passwordStringauthenticationDit kodeord. Du kan finde det på din epay-konto.Ja
paymentrequestidLongpaymentrequestDet unikke nummer, der identificerer betalingsanmodningen. Ja

Her følger beskrivelser af output-felterne, som er dem, API'et returnerer.

OutputTypeVærdierBeskrivelse
resultBooleanSe beskrivelsen af output values.
messageStringHvis result er false, vil message vise en detaljeret fejlbesked.
reasonEnum0 = OK
1 = Error

requestresponselogidLongDenne medtages kun på testkonto, eller hvis der er opstået en fejl på produktionskontoen (result er false).
Output valuesHvis kaldet er en succes, returneres result som true. Ellers er den returnerede værdi false. Returneres false, bruges message til at finde fejlårsagen.

Metoder til form

Det følgende beskriver metoderne til håndtering af formularer på betalingsanmodninger.

createform

createform opretter en html-formular på betalingsanmodningen.

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

InputTypeObjektTypeVærdierBeskrivelseObligatorisk
merchantnumberStringauthenticationDit unikke forretningsnummer. Du kan finde det på din indløsningsaftale (f.eks. med Nets).Ja
passwordStringauthenticationDit kodeord. Du kan finde det på din epay-konto.Ja
nameStringformFormularens navnJa
nameStringinputlistMaks. 255 tegnFeltets navnJa
descriptionStringinputlistMaks. 40 tegnPlaceholder-tekst til feltetNej
validationStringinputlistMaks. 1024 tegnRegulært udtryk til at validere felttypenNej
sortorderIntegerinputlist0 = stigende
1 = faldende
Definer, hvilken rækkefølge feltet skal sorteres i.Nej
typeEnumtype1 = text
2 = checkbox
3 = select
Definer, hvilken type feltet skal være.Nej
valueStringoptionlistMaks. 100 tegnListe, som bruges, hvis select-typen er valgt.Nej
termsurlStringformGyldig URL. Maks. 4096 tegnURL til dine betingelserNej
languageStringAngiv, hvilket sprog du vil modtage fejlbeskeder på.Nej
localtimezoneBooleanTrue/falseTrue = lokaltidNej

Her følger beskrivelser af output-felterne, som er dem, API'et returnerer.

OutputTypeVærdierBeskrivelse
formidIntegerID på den oprettede formular
resultBooleanSe beskrivelsen af output values
messageStringHvis result er false, vil message vise en detaljeret fejlbesked.
reasonEnum0 = OK
1 = Error

requestresponselogidLongDenne medtages kun på testkonto, eller hvis der er opstået en fejl på produktionskontoen (result er false).
Output valuesHvis kaldet er en succes, returneres result som true. Ellers er den returnerede værdi false. Returneres false, bruges message til at finde fejlårsagen.

deleteform

deleteform sletter en html-formular på betalingsanmodningen.

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

InputTypeObjektTypeVærdierBeskrivelseObligatorisk
merchantnumberStringauthenticationDit unikke forretningsnummer. Du kan finde det på din indløsningsaftale (f.eks. med Nets).Ja
passwordStringauthenticationDit kodeord. Du kan finde det på din epay-konto.Ja
formidLongformID'et på den formular, du vil slette.Ja
languageStringAngiv, hvilket sprog du vil modtage fejlbeskeder på.Nej
localtimezoneBooleanTrue/falseTrue = lokaltidNej

Her følger beskrivelser af output-felterne, som er dem, API'et returnerer.

OutputTypeVærdierBeskrivelse
resultBooleanSe beskrivelsen af output values
messageStringHvis result er false, vil message vise en detaljeret fejlbesked.
reasonEnum0 = OK
1 = Error

requestresponselogidLongDenne medtages kun på testkonto, eller hvis der er opstået en fejl på produktionskontoen (result er false).
Output valuesHvis kaldet er en succes, returneres result som true. Ellers er den returnerede værdi false. Returneres false, bruges message til at finde fejlårsagen.

getform

getform henter en html-formular til betalingsanmodningen baseret på formid.

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

InputTypeObjektTypeVærdierBeskrivelseObligatorisk
merchantnumberStringauthenticationDit unikke forretningsnummer. Du kan finde det på din indløsningsaftale (f.eks. med Nets).Ja
passwordStringauthenticationDit kodeord. Du kan finde det på din epay-konto.Ja
formidLongformID'et på den formular, du vil hente.Ja
languageStringAngiv, hvilket sprog du vil modtage fejlbeskeder på.Nej
localtimezoneBooleanTrue/falseTrue = lokaltidNej

Her følger beskrivelser af output-felterne, som er dem, API'et returnerer.

OutputTypeVærdierBeskrivelse
description (input)StringBeskrivelse af feltet
name (input)StringFeltets navn
value (option)StringFeltets værdi
type (input)EnumDefinerer, hvilken type feltet er.
validation (input)StringViser det regulære udtræk
termsurlStringURL til betingelserne
name
Formularens navn
resultBooleanSe beskrivelsen af output values
messageStringHvis result er false, vil message vise en detaljeret fejlbesked.
reasonEnum0 = OK
1 = Error
requestresponselogidLongDenne medtages kun på testkonto, eller hvis der er opstået en fejl på produktionskontoen (result er false).
Output valuesHvis kaldet er en succes, returneres result som true. Ellers er den returnerede værdi false. Returneres false, bruges message til at finde fejlårsagen.

listform

listform henter en liste med html-formularer til betalingsanmodningen baseret på formid.

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

InputTypeObjektTypeVærdierBeskrivelseObligatorisk
merchantnumberStringauthenticationDit unikke forretningsnummer. Du kan finde det på din indløsningsaftale (f.eks. med Nets).Ja
passwordStringauthenticationDit kodeord. Du kan finde det på din epay-konto.Ja
sortingEnumsorting0 = stigende 
1 = faldende
Angiv, hvilken sortering der skal anvendes på listen.Nej
exclusivestartkeyLongpagingAngiv det formid, hvorfra udtrækket skal starte. Bemærk: Denne medtages ikke i udtrækket.Nej
pagesizeIntegerpaging20-100Størrelsen på den liste, der vises.Nej
languageStringAngiv, hvilket sprog du vil modtage fejlbeskeder på.Nej
localtimezoneBooleanTrue/falseTrue = lokaltidNej

Her følger beskrivelser af output-felterne, som er dem, API'et returnerer.

OutputTypeVærdierBeskrivelse
formid IntegerID'et på formularen
name StringFormularens navn
pagesize (paging)IntegerStørrelsen på den liste, der vises.
lastevaluatedkeyLongDet formid, som sidst er tilføjet listen.
resultBooleanSe beskrivelsen af output values
messageStringHvis result er false, vil message vise en detaljeret fejlbesked.
reasonEnum0 = OK
1 = Error
requestresponselogidLongDenne medtages kun på testkonto, eller hvis der er opstået en fejl på produktionskontoen (result er false).
Output valuesHvis kaldet er en succes, returneres result som true. Ellers er den returnerede værdi false. Returneres false, bruges message til at finde fejlårsagen.

Metoder til requestresponselog

Det følgende beskriver metoderne til håndtering af forespørgsler/svar baseret på logid.

getrequestresponselog

getrequestresponselog henter information om forespørgsler/svar baseret på logid.

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

InputTypeObjektTypeVærdierBeskrivelseObligatorisk
merchantnumberStringauthenticationDit unikke forretningsnummer. Du kan finde det på din indløsningsaftale (f.eks. med Nets).Ja
passwordStringauthenticationDit kodeord. Du kan finde det på din epay-konto.Ja
requestresponselogidLongrequestresponselogDet unikke nummer, der identificerer logid'et. Ja

Her følger beskrivelser af output-felterne, som er dem, API'et returnerer.

OutputTypeVærdierBeskrivelse
processingtimeinmsIntegerDen tid i milisekunder, som kaldet har taget.
requestapimethodStringNavnet på den kaldte metode
requestcontentencodingStringEncodingtype på forespørgsel
requestcontenttypeStringEks. "application/json", "text/xml; charset=utf-8”Contenttype på forespørgsel
requestcreatedDatetimeDato for forespørgsel
requesthttpmethodStringPUT, POST, GETHttp-metode
requestinputstreamStringInput stream
requestipStringDen IP-adresse, som forespørgslen kommer fra.
requestrawurlStringURL på den aktuelle forespørgsel
requestresponselogidLongDet unikke nummer, der identificerer logid'et.
responsecontentencodingStringEncodingtype på svar
responsecontenttypeStringContenttype på svar
responsecreatedDatetimeDato for svar
responseoutputstreamStringResponseoutputstream på svar
responseresultBooleanSe beskrivelsen af output values.
resultBooleanSe beskrivelsen af output values.
messageStringHvis result er false, vil message vise en detaljeret fejlbesked.
reasonEnum0 = OK
1 = Error

requestresponselogidLongDenne medtages kun på testkonto, eller hvis der er opstået en fejl på produktionskontoen (result er false).
Output valuesHvis kaldet er en succes, returneres result som true. Ellers er den returnerede værdi false. Returneres false, bruges message til at finde fejlårsagen.

listrequestresponselog

listrequestresponselog henter en liste med information om forespørgsler/svar baseret på logid.

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

InputTypeObjektTypeVærdierBeskrivelseObligatorisk
merchantnumberStringauthenticationDit unikke forretningsnummer. Du kan finde det på din indløsningsaftale (f.eks. med Nets).Ja
passwordStringauthenticationDit kodeord. Du kan finde det på din epay-konto.Ja
exclusivestartkeyLongpagingDet requestresponselogid, hvorfra udtrækket skal starte. 
Bemærk! Denne medtages ikke i udtrækket.
Nej
pagesizeIntegerpagingStørrelsen på den liste, der hentes.Nej
languageString
Angiv, hvilket sprog fejlbeskeder skal være på.Nej
localtimezoneBoolean
True = lokaltidNej

Her følger beskrivelser af output-felterne, som er dem, API'et returnerer.

OutputTypeVærdierBeskrivelse
processingtimeinmsIntegerDen tid i milisekunder, som kaldet har taget.
requestapimethodStringNavnet på den kaldte metode
requestcontentencodingStringEncodingtype på forespørgsel
requestcontenttypeStringEks. "application/json", "text/xml; charset=utf-8”Contenttype på forespørgsel
requestcreatedDatetimeDato for forespørgsel
requesthttpmethodStringPUT, POST, GETHttp-metode
requestipStringDen IP-adresse, som forespørgslen kommer fra.
requestrawurlStringURL på den aktuelle forespørgsel
requestresponselogidLongDet unikke nummer, der identificerer logid'et.
responsecontentencodingStringEncodingtype på svar
responsecontenttypeStringContenttype på svar
responsecreatedDatetimeDato for svar
responseresultBooleanSe beskrivelsen af output values.
pagesize (paging)IntegerStørrelsen på den liste, der hentes.
lastevaluatedkeyLongDet transactionid, som sidst er tilføjet listen.
resultBooleanSe beskrivelsen af output values.
messageStringHvis result er false, vil message vise en detaljeret fejlbesked.
reasonEnum0 = OK
1 = Error
requestresponselogidLongDenne medtages kun på testkonto, eller hvis der er opstået en fejl på produktionskontoen (result er false).
Output valuesHvis kaldet er en succes, returneres result som true. Ellers er den returnerede værdi false. Returneres false, bruges message til at finde fejlårsagen.

Metoder til transaction

Det følgende beskriver metoderne til håndtering af transaktioner i forbindelse med betalingsanmodninger.

addtransaction

addtransaction knytter en transaktion til en betalingsanmodning.

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

InputTypeObjektTypeVærdierBeskrivelseObligatorisk
merchantnumberStringauthentication
Dit unikke forretningsnummer. Du kan finde det på din indløsningsaftale (f.eks. med Nets).Ja
passwordStringauthentication
Dit kodeord. Du kan finde det på din epay-konto.
Ja
paymentrequestidLongpaymentrequest

Det unikke nummer, der identificerer betalingsanmodningen. 
Ja
transactionid
Longtransaction
Det unikke nummer, der identificerer transaktionen.
Ja
language
String

Angiv, hvilket sprog du vil modtage fejlbeskeder på.Nej
localtimezone
Boolean
True/false True = lokaltid
Nej

Her følger beskrivelser af output-felterne, som er dem, API'et returnerer.

OutputTypeVærdierBeskrivelse
resultBooleanSe beskrivelsen af output values.
messageStringHvis result er false, vil message vise en detaljeret fejlbesked.
reasonEnum0 = OK
1 = Error

requestresponselogidLongDenne medtages kun på testkonto, eller hvis der er opstået en fejl på produktionskontoen (result er false).
Output valuesHvis kaldet er en succes, returneres result som true. Ellers er den returnerede værdi false. Returneres false, bruges message til at finde fejlårsagen.

gettransaction

gettransaction henter transaktionsinformationer baseret på paymentrequestid og transactionid.

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

InputTypeObjektTypeVærdierBeskrivelseObligatorisk
merchantnumberStringauthenticationDit unikke forretningsnummer. Du kan finde det på din indløsningsaftale (f.eks. med Nets).Ja
passwordStringauthenticationDit kodeord. Du kan finde det på din epay-konto.Ja
paymentrequestidLongpaymentrequestDet unikke nummer, der identificerer betalingsanmodningen. Ja
transactionidLongtransactionDet unikke nummer, der identificerer transaktionen.Ja
languageStringAngiv, hvilket sprog du vil modtage fejlbeskeder på.Nej
localtimezoneBooleanTrue/falseTrue = lokaltidNej

Her følger beskrivelser af output-felterne, som er dem, API'et returnerer.

OutputTypeVærdierBeskrivelse
transactionidIntegerDet unikke nummer, der identificerer betalingen.
createdDatetimeOprettelsesdato
name (inputlist)StringNavn på input
value (inputlist)StringVærdi på input
resultBooleanSe beskrivelsen af output values.
messageStringHvis result er false, vil message vise en detaljeret fejlbesked.
reasonEnum0 = OK
1 = Error

requestresponselogidLongDenne medtages kun på testkonto, eller hvis der er opstået en fejl på produktionskontoen (result er false).
Output valuesHvis kaldet er en succes, returneres result som true. Ellers er den returnerede værdi false. Returneres false, bruges message til at finde fejlårsagen.

listtransaction

listtransaction henter en liste med informationer om betalingsanmodninger baseret på paymentrequestid.

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

InputTypeObjektTypeVærdierBeskrivelseObligatorisk
merchantnumberStringauthenticationDit unikke forretningsnummer. Du kan finde det på din indløsningsaftale (f.eks. med Nets).Ja
passwordStringauthenticationDit kodeord. Du kan finde det på din epay-konto.Ja
paymentrequestidLongpaymentrequestDet unikke nummer, der identificerer betalingsanmodningen. Ja
sortingEnumsorting0 = stigende
1 = faldende
Angiv, hvilken sortering der anvendes på liste baseret på oprettelsesdatoen. Nej
exclusivestartkeyLongpagingDet transactionid, hvorfra udtrækket skal starte. 
Bemærk! Denne medtages ikke i udtrækket.
Nej
pagesizeIntegerpaging20-100Størrelsen på den liste, der hentes. Nej
languageStringAngiv, hvilket sprog du vil modtage fejlbeskeder på.Nej
localtimezoneBooleanTrue/falseTrue = lokaltidNej

Her følger beskrivelser af output-felterne, som er dem, API'et returnerer.

OutputTypeVærdierBeskrivelse
transactionid (transactionlist)IntegerDet unikke nummer, der identificerer betalingen.
created (transactionlist)DatetimeOprettelsesdato
name (inputlist)StringNavn på input
value (inputlist)StringVærdi på input
pagesize (paging)IntegerStørrelsen på den liste, der hentes.
lastevaluatedkeyLong
Det transactionid, som sidst er tilføjet listen.
resultBooleanSe beskrivelsen af output values.
messageStringHvis result er false, vil message vise en detaljeret fejlbesked.
reasonEnum0 = OK
1 = Error
requestresponselogidLongDenne medtages kun på testkonto, eller hvis der er opstået en fejl på produktionskontoen (result er false).
Output valuesHvis kaldet er en succes, returneres result som true. Ellers er den returnerede værdi false. Returneres false, bruges message til at finde fejlårsagen.