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
This is an overview of available parameters. Default values are set in bold.
You'll find detailed specifications for each parameter under Specifications
You can find the API reference here: https://paymentrequest.api.epay.eu/v1/Operations.aspx?uri=createpaymentrequest
| Name | Values | Description | Required |
| authentication.merchantnumber | Type: string | Your unique merchant number. You can find it on your merchant agreement. | Yes |
| authentication.password | Type: string | Your password. Find it on your Bambora account. | Yes |
| language | Type: string | Indicate in which language you want to receive error messages. | No |
| localtimezone | Type: boolean | True = local time | No |
| paymentrequest.exactclosedate | Type: Datetime | Specify a closing date for the payment request. | No |
| paymentrequest.closeafterxpayments | Type: integer | Specify the number of payments to be completed before the payment request closes. | No |
| reference | Type: string | Reference to the payment request. It's a reference that you create and assign to the payment request | Yes |
| paymentrequest.parameters | Type: Parameters (PaymentRequest) | An object containing the attributes to the Payment Window. | Yes |
Response
| Output | Values | Description | |
| paymentrequestid | Type: long | The unique number identifying the payment request. |
| key (paymentrequest) | Type: string | Key which is used for finding the payment request. This is a security measurement to avoid that payment requests can be found using only paymentrequestid. |
| link (paymentrequest) | Type: string | URL for the payment request |
| result | Type: boolean | See description of output values. |
| message | Type: string | If result is false, message will show a detailed error description. |
| reason | Type: enum |
| requestresponselogid | Type: long | This is only included for test accounts or if an error occured (result is false). |
| Output values | If the call was successful, result is returned as true. If not, the returning value is false. When false is returned, please use message to detect the source of error. |
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.
| Input | Type | ObjektType | Værdier | Beskrivelse | Obligatorisk |
| merchantnumber | String | authentication | | Dit unikke forretningsnummer. Du kan finde det på din indløsningsaftale (f.eks. med Nets). | Ja |
| password | String | authentication | | Dit kodeord. Du kan finde det på din Bambora-konto. | Ja |
| paymentrequestid | Long | paymentrequest | | Det unikke nummer, der identificerer betalingsanmodningen.
| 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.
| Output | Type | Værdier | Beskrivelse |
| closeafterxpayments (paymentrequest) | Integer | | Din angivelse af, hvor mange betalinger der må gennemføres, inden betalingsanmodningen lukkes. |
| exactclosedate (paymentrequest) | Datetime | | Den dato, hvor betalingsanmodningen lukker. |
| key (paymentrequest) | String | | Nøgle, som bruges til at finde betalingsanmodningen. Det er en sikkerhed, så betalingsanmodninger ikke kan findes på paymentrequestid alene. |
| link (paymentrequest) | String | | URL til betalingsanmodningen |
| reference | String | | Referencenavn til betalingsanmodningen |
| status | Enum | 1 = Åben
2 = Lukket
3 = Arkiveret |
|
parameters - klik her for at se alle parametre (JSON body).
Den tekniske dokumentation til parametre findes her. |
| |
|
| result | Boolean | | Se beskrivelsen af output values. |
| message | String | | Hvis result er false, vil message vise en detaljeret fejlbesked. |
| reason | Enum | | |
| requestresponselogid | Long | | Denne medtages kun på testkonto, eller hvis der er opstået en fejl på produktionskontoen (result er false). |
| Output values | Hvis 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.
| Input | Type | ObjektType | Værdier | Beskrivelse | Obligatorisk |
| merchantnumber | String | authentication | | Dit unikke forretningsnummer. Du kan finde det på din indløsningsaftale (f.eks. med Nets). | Ja |
| password | String | authentication | | Dit kodeord. Du kan finde det på din Bambora-konto. | Ja |
| sorting | Enum | sorting | 0 = stigende
1 = faldende | Angiv, hvilken sortering der anvendes på listen ud fra oprettelsesdatoen. | Nej |
| exclusivestartkey | Long | paging | | Det paymentrequestid, hvorfra udtrækket skal starte.
Bemærk! Denne medtages ikke i udtrækket. | Nej |
| pagesize | Integer | paging | 20-100 | Størrelsen på den liste, der hentes. | Nej |
| 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.
| Output | Type | Værdier | Beskrivelse |
| paymentrequestid (paymentrequestlist) | Long | | Det unikke nummer, der identificerer betalingen. |
| amount (transactionlist) | Inteher | | Betalingsanmodningens beløb |
| created (transactionlist) | Datetime | | Oprettelsesdato |
| currency (transactionlist) | String | | Betalingsanmodningens valuta |
| numberoftransactions (transactionlist) | Integer | | Antal 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. |
| lastevaluatedkey | Long |
| Det transactionid, som sidst er tilføjet listen.
|
| result | Boolean | | Se beskrivelsen af output values. |
| message | String | | Hvis result er false, vil message vise en detaljeret fejlbesked. |
| reason | Enum | 0 = OK
1 = Error | |
| requestresponselogid | Long | | Denne medtages kun på testkonto, eller hvis der er opstået en fejl på produktionskontoen (result er false). |
| Output values | Hvis 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.
| Input | Type | ObjektType | Værdier | Beskrivelse | Obligatorisk |
| merchantnumber | String | authentication | | Dit unikke forretningsnummer. Du kan finde det på din indløsningsaftale (f.eks. med Nets). | Ja |
| password | String | authentication | | Dit kodeord. Du kan finde det på din Bambora-konto. | Ja |
| paymentrequestid | Long | paymentrequest | | Det unikke nummer, der identificerer betalingsanmodningen. | Ja |
Her følger beskrivelser af output-felterne, som er dem, API'et returnerer.
| Output | Type | Værdier | Beskrivelse |
| result | Boolean | | Se beskrivelsen af output values. |
| message | String | | Hvis result er false, vil message vise en detaljeret fejlbesked. |
| reason | Enum | 0 = OK
1 = Error |
|
| requestresponselogid | Long | | Denne medtages kun på testkonto, eller hvis der er opstået en fejl på produktionskontoen (result er false). |
| Output values | Hvis 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.
| Input | Type | ObjektType | Værdier | Beskrivelse | Obligatorisk |
| merchantnumber | String | authentication | | Dit unikke forretningsnummer. Du kan finde det på din indløsningsaftale (f.eks. med Nets). | Ja |
| password | String | authentication | | Dit kodeord. Du kan finde det på din Bambora-konto. | Ja |
| name | String | recipient |
| Navnet på modtageren af betalingsanmodningen | Ja |
| emailaddress | String | recipient | Valid email
| E-mailadressen på modtageren af betalingsanmodningen | Ja |
| requester | String | email |
| Angiv for at få mulighed for at tilføje afsendernavn i mailen, der sendes ud. | Nej |
| comment | String | email |
| Angiv for at få mulighed for at tilføje et kommentarfelt i mailen, der sendes ud.
| Nej |
| name | String | replyto |
| Angiv et navn, som bruges ved besvarelse af betalingsanmodningen. | Nej |
| emailaddress | String | replyto | Valid email | Angiv en e-mailadresse, som bruges ved besvarelse af betalingsanmodningen. | Nej |
| paymentrequestid | Long | paymentrequest | | Det unikke nummer, der identificerer betalingsanmodningen. | Ja |
Her følger beskrivelser af output-felterne, som er dem, API'et returnerer.
| Output | Type | Værdier | Beskrivelse |
| result | Boolean | | Se beskrivelsen af output values. |
| message | String | | Hvis result er false, vil message vise en detaljeret fejlbesked. |
| reason | Enum | 0 = OK
1 = Error |
|
| requestresponselogid | Long | | Denne medtages kun på testkonto, eller hvis der er opstået en fejl på produktionskontoen (result er false). |
| Output values | Hvis 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.
| Input | Type | ObjektType | Værdier | Beskrivelse | Obligatorisk |
| merchantnumber | String | authentication | | Dit unikke forretningsnummer. Du kan finde det på din indløsningsaftale (f.eks. med Nets). | Ja |
| password | String | authentication | | Dit kodeord. Du kan finde det på din Bambora-konto. | Ja |
| paymentrequestid | Long | paymentrequest | | Det unikke nummer, der identificerer betalingsanmodningen. | Ja |
Her følger beskrivelser af output-felterne, som er dem, API'et returnerer.
| Output | Type | Værdier | Beskrivelse |
| result | Boolean | | Se beskrivelsen af output values. |
| message | String | | Hvis result er false, vil message vise en detaljeret fejlbesked. |
| reason | Enum | 0 = OK
1 = Error |
|
| requestresponselogid | Long | | Denne medtages kun på testkonto, eller hvis der er opstået en fejl på produktionskontoen (result er false). |
| Output values | Hvis 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.
| Input | Type | ObjektType | Værdier | Beskrivelse | Obligatorisk |
| merchantnumber | String | authentication | | Dit unikke forretningsnummer. Du kan finde det på din indløsningsaftale (f.eks. med Nets). | Ja |
| password | String | authentication | | Dit kodeord. Du kan finde det på din Bambora-konto. | Ja |
| name | String | form | | Formularens navn | Ja |
| name | String | inputlist | Maks. 255 tegn | Feltets navn | Ja |
| description | String | inputlist | Maks. 40 tegn | Placeholder-tekst til feltet | Nej |
| validation | String | inputlist | Maks. 1024 tegn | Regulært udtryk til at validere felttypen | Nej |
| sortorder | Integer | inputlist | 0 = stigende
1 = faldende | Definer, hvilken rækkefølge feltet skal sorteres i. | Nej |
| type | Enum | type | 1 = text
2 = checkbox
3 = select | Definer, hvilken type feltet skal være. | Nej |
| value | String | optionlist | Maks. 100 tegn | Liste, som bruges, hvis select-typen er valgt. | Nej |
| termsurl | String | form | Gyldig URL. Maks. 4096 tegn | URL til dine betingelser | Nej |
| 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.
| Output | Type | Værdier | Beskrivelse |
| formid | Integer | | ID på den oprettede formular |
| result | Boolean | | Se beskrivelsen af output values |
| message | String | | Hvis result er false, vil message vise en detaljeret fejlbesked.
|
| reason | Enum | 0 = OK
1 = Error |
|
| requestresponselogid | Long | | Denne medtages kun på testkonto, eller hvis der er opstået en fejl på produktionskontoen (result er false). |
| Output values | Hvis 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.
| Input | Type | ObjektType | Værdier | Beskrivelse | Obligatorisk |
| merchantnumber | String | authentication | | Dit unikke forretningsnummer. Du kan finde det på din indløsningsaftale (f.eks. med Nets). | Ja |
| password | String | authentication | | Dit kodeord. Du kan finde det på din Bambora-konto. | Ja |
| formid | Long | form | | ID'et på den formular, du vil slette. | 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.
| Output | Type | Værdier | Beskrivelse |
| result | Boolean | | Se beskrivelsen af output values |
| message | String | | Hvis result er false, vil message vise en detaljeret fejlbesked.
|
| reason | Enum | 0 = OK
1 = Error |
|
| requestresponselogid | Long | | Denne medtages kun på testkonto, eller hvis der er opstået en fejl på produktionskontoen (result er false). |
| Output values | Hvis 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.
| Input | Type | ObjektType | Værdier | Beskrivelse | Obligatorisk |
| merchantnumber | String | authentication | | Dit unikke forretningsnummer. Du kan finde det på din indløsningsaftale (f.eks. med Nets). | Ja |
| password | String | authentication | | Dit kodeord. Du kan finde det på din Bambora-konto. | Ja |
| formid | Long | form | | ID'et på den formular, du vil hente. | 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.
| Output | Type | Værdier | Beskrivelse |
| description (input) | String | | Beskrivelse af feltet |
| name (input) | String | | Feltets navn |
| value (option) | String | | Feltets værdi |
| type (input) | Enum | | Definerer, hvilken type feltet er. |
| validation (input) | String | | Viser det regulære udtræk |
| termsurl | String | | URL til betingelserne |
| name |
| | Formularens navn |
| result | Boolean | | Se beskrivelsen af output values |
| message | String | | Hvis result er false, vil message vise en detaljeret fejlbesked. |
| reason | Enum | 0 = OK
1 = Error | |
| requestresponselogid | Long | | Denne medtages kun på testkonto, eller hvis der er opstået en fejl på produktionskontoen (result er false). |
| Output values | Hvis 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.
| Input | Type | ObjektType | Værdier | Beskrivelse | Obligatorisk |
| merchantnumber | String | authentication | | Dit unikke forretningsnummer. Du kan finde det på din indløsningsaftale (f.eks. med Nets). | Ja |
| password | String | authentication | | Dit kodeord. Du kan finde det på din Bambora-konto. | Ja |
| sorting | Enum | sorting | 0 = stigende
1 = faldende | Angiv, hvilken sortering der skal anvendes på listen. | Nej |
| exclusivestartkey | Long | paging | | Angiv det formid, hvorfra udtrækket skal starte. Bemærk: Denne medtages ikke i udtrækket. | Nej |
| pagesize | Integer | paging | 20-100 | Størrelsen på den liste, der vises. | Nej |
| 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.
| Output | Type | Værdier | Beskrivelse |
| formid | Integer | | ID'et på formularen |
| name | String | | Formularens navn |
| pagesize (paging) | Integer | | Størrelsen på den liste, der vises. |
| lastevaluatedkey | Long | | Det formid, som sidst er tilføjet listen. |
| result | Boolean | | Se beskrivelsen af output values |
| message | String | | Hvis result er false, vil message vise en detaljeret fejlbesked. |
| reason | Enum | 0 = OK
1 = Error | |
| requestresponselogid | Long | | Denne medtages kun på testkonto, eller hvis der er opstået en fejl på produktionskontoen (result er false). |
| Output values | Hvis 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.
| Input | Type | ObjektType | Værdier | Beskrivelse | Obligatorisk |
| merchantnumber | String | authentication | | Dit unikke forretningsnummer. Du kan finde det på din indløsningsaftale (f.eks. med Nets). | Ja |
| password | String | authentication | | Dit kodeord. Du kan finde det på din Bambora-konto. | Ja |
| requestresponselogid | Long | requestresponselog | | Det unikke nummer, der identificerer logid'et. | Ja |
Her følger beskrivelser af output-felterne, som er dem, API'et returnerer.
| Output | Type | Værdier | Beskrivelse |
| processingtimeinms | Integer | | Den tid i milisekunder, som kaldet har taget.
|
| requestapimethod | String | | Navnet på den kaldte metode |
| requestcontentencoding | String | | Encodingtype på forespørgsel |
| requestcontenttype | String | Eks. "application/json", "text/xml; charset=utf-8” | Contenttype på forespørgsel |
| requestcreated | Datetime | | Dato for forespørgsel |
| requesthttpmethod | String | PUT, POST, GET | Http-metode |
| requestinputstream | String | | Input stream
|
| requestip | String | | Den IP-adresse, som forespørgslen kommer fra.
|
| requestrawurl | String | | URL på den aktuelle forespørgsel |
| requestresponselogid | Long | | Det unikke nummer, der identificerer logid'et. |
| responsecontentencoding | String | | Encodingtype på svar
|
| responsecontenttype | String | | Contenttype på svar |
| responsecreated | Datetime | | Dato for svar |
| responseoutputstream | String | | Responseoutputstream på svar |
| responseresult | Boolean | | Se beskrivelsen af output values. |
| result | Boolean | | Se beskrivelsen af output values. |
| message | String | | Hvis result er false, vil message vise en detaljeret fejlbesked. |
| reason | Enum | 0 = OK
1 = Error |
|
| requestresponselogid | Long | | Denne medtages kun på testkonto, eller hvis der er opstået en fejl på produktionskontoen (result er false). |
| Output values | Hvis 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.
| Input | Type | ObjektType | Værdier | Beskrivelse | Obligatorisk |
| merchantnumber | String | authentication | | Dit unikke forretningsnummer. Du kan finde det på din indløsningsaftale (f.eks. med Nets). | Ja |
| password | String | authentication | | Dit kodeord. Du kan finde det på din Bambora-konto. | Ja |
| exclusivestartkey | Long | paging | | Det requestresponselogid, hvorfra udtrækket skal starte.
Bemærk! Denne medtages ikke i udtrækket.
| Nej |
| pagesize | Integer | paging | | Størrelsen på den liste, der hentes. | Nej |
| language | String |
| | Angiv, hvilket sprog fejlbeskeder skal være på. | Nej |
| localtimezone | Boolean |
| | True = lokaltid | Nej |
Her følger beskrivelser af output-felterne, som er dem, API'et returnerer.
| Output | Type | Værdier | Beskrivelse |
| processingtimeinms | Integer | | Den tid i milisekunder, som kaldet har taget. |
| requestapimethod | String | | Navnet på den kaldte metode |
| requestcontentencoding | String | | Encodingtype på forespørgsel |
| requestcontenttype | String | Eks. "application/json", "text/xml; charset=utf-8” | Contenttype på forespørgsel |
| requestcreated | Datetime | | Dato for forespørgsel |
| requesthttpmethod | String | PUT, POST, GET | Http-metode |
| requestip | String | | Den IP-adresse, som forespørgslen kommer fra. |
| requestrawurl | String | | URL på den aktuelle forespørgsel |
| requestresponselogid | Long | | Det unikke nummer, der identificerer logid'et. |
| responsecontentencoding | String | | Encodingtype på svar |
| responsecontenttype | String | | Contenttype på svar |
| responsecreated | Datetime | | Dato for svar |
| responseresult | Boolean | | Se beskrivelsen af output values. |
| pagesize (paging) | Integer | | Størrelsen på den liste, der hentes. |
| lastevaluatedkey | Long | | Det transactionid, som sidst er tilføjet listen. |
| result | Boolean | | Se beskrivelsen af output values. |
| message | String | | Hvis result er false, vil message vise en detaljeret fejlbesked. |
| reason | Enum | 0 = OK
1 = Error | |
| requestresponselogid | Long | | Denne medtages kun på testkonto, eller hvis der er opstået en fejl på produktionskontoen (result er false). |
| Output values | Hvis 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.
| Input | Type | ObjektType | Værdier | Beskrivelse | Obligatorisk |
| merchantnumber | String | authentication |
| Dit unikke forretningsnummer. Du kan finde det på din indløsningsaftale (f.eks. med Nets). | Ja |
| password | String | authentication |
| Dit kodeord. Du kan finde det på din Bambora-konto.
| Ja |
| paymentrequestid | Long | paymentrequest
|
| Det unikke nummer, der identificerer betalingsanmodningen.
| Ja |
transactionid
| Long | transaction |
| 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.
| Output | Type | Værdier | Beskrivelse
|
| result | Boolean | | Se beskrivelsen af output values. |
| message | String | | Hvis result er false, vil message vise en detaljeret fejlbesked. |
| reason | Enum | 0 = OK
1 = Error |
|
| requestresponselogid | Long | | Denne medtages kun på testkonto, eller hvis der er opstået en fejl på produktionskontoen (result er false).
|
| Output values | Hvis 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.
| Input | Type | ObjektType | Værdier | Beskrivelse | Obligatorisk |
| merchantnumber | String | authentication | | Dit unikke forretningsnummer. Du kan finde det på din indløsningsaftale (f.eks. med Nets). | Ja |
| password | String | authentication | | Dit kodeord. Du kan finde det på din Bambora-konto. | Ja |
| paymentrequestid | Long | paymentrequest | | Det unikke nummer, der identificerer betalingsanmodningen. | Ja |
| transactionid | Long | transaction | | 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.
| Output | Type | Værdier | Beskrivelse |
| transactionid | Integer | | Det unikke nummer, der identificerer betalingen. |
| created | Datetime | | Oprettelsesdato |
| name (inputlist) | String | | Navn på input |
| value (inputlist) | String | | Værdi på input |
| result | Boolean | | Se beskrivelsen af output values. |
| message | String | | Hvis result er false, vil message vise en detaljeret fejlbesked. |
| reason | Enum | 0 = OK
1 = Error |
|
| requestresponselogid | Long | | Denne medtages kun på testkonto, eller hvis der er opstået en fejl på produktionskontoen (result er false). |
| Output values | Hvis 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.
| Input | Type | ObjektType | Værdier | Beskrivelse | Obligatorisk |
| merchantnumber | String | authentication | | Dit unikke forretningsnummer. Du kan finde det på din indløsningsaftale (f.eks. med Nets). | Ja |
| password | String | authentication | | Dit kodeord. Du kan finde det på din Bambora-konto. | Ja |
| paymentrequestid | Long | paymentrequest | | Det unikke nummer, der identificerer betalingsanmodningen. | Ja |
| sorting | Enum | sorting | 0 = stigende
1 = faldende | Angiv, hvilken sortering der anvendes på liste baseret på oprettelsesdatoen. | Nej |
| exclusivestartkey | Long | paging | | Det transactionid, hvorfra udtrækket skal starte.
Bemærk! Denne medtages ikke i udtrækket. | Nej |
| pagesize | Integer | paging | 20-100 | Størrelsen på den liste, der hentes. | Nej |
| 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.
| Output | Type | Værdier | Beskrivelse |
| transactionid (transactionlist) | Integer | | Det unikke nummer, der identificerer betalingen. |
| created (transactionlist) | Datetime | | Oprettelsesdato |
| name (inputlist) | String | | Navn på input |
| value (inputlist) | String | | Værdi på input |
| pagesize (paging) | Integer | | Størrelsen på den liste, der hentes. |
| lastevaluatedkey | Long |
| Det transactionid, som sidst er tilføjet listen. |
| result | Boolean | | Se beskrivelsen af output values. |
| message | String | | Hvis result er false, vil message vise en detaljeret fejlbesked. |
| reason | Enum | 0 = OK
1 = Error | |
| requestresponselogid | Long | | Denne medtages kun på testkonto, eller hvis der er opstået en fejl på produktionskontoen (result er false). |
| Output values | Hvis kaldet er en succes, returneres result som true. Ellers er den returnerede værdi false. Returneres false, bruges message til at finde fejlårsagen. |
