Purpose:
The returnAmount function is used to give discounts on invoices.
If you are using standard integration and the purchase is not yet activated (you have not yet delivered the goods), just change the article list in our online interface Klarna Online.
Return value:
String - Invoice number for the discounted invoice or Throws an exception with error code and error message.
Code examples
Please note that you can find more code examples in our API-files which you will find under Download API in the left menu.
The code examples have been divided into several steps. Click on the step you would like to see the code example.
1. Initialize and setup the Klarna instance
$k = new Klarna();
$k->config(
123456, // Merchant ID
'sharedSecret', // Shared Secret
KlarnaCountry::SE, // Country
KlarnaLanguage::SV, // Language
KlarnaCurrency::SEK, // Currency
Klarna::BETA, // Server
'json', // PClass Storage
'/srv/pclasses.json', // PClass Storage URI path
true, // SSL
true // Remote logging of response times of xmlrpc calls
);
2. Give a discount on the invoice
$invNo = '123456';
try {
$result = $k->returnAmount(
$invNo, // Invoice number
19.99, // Amount given as a discount.
25, // 25% VAT
KlarnaFlags::INC_VAT // Amount including VAT.
);
echo "Result: {$result}\n";
/* Discount given, proceed accordingly.
$result contains the invoice number of the discounted invoice.
*/
} catch(Exception $e) {
// Something went wrong, print the message:
echo "{$e->getMessage()} (#{$e->getCode()})\n";
}
The code examples have been divided into several steps. Click on the step you would like to see the code example.
1. Initialize and setup the Klarna instance
API klarna = new API ();
/** Configure the Klarna object **/
klarna.Config (new KlarnaConfig () {
EID = 123456,
Secret = "sharedsecret",
Country = API.Country.Sweden,
Language = API.Language.Swedish,
Currency = API.Currency.SEK,
Encoding = API.Encoding.Swedish,
// API.KlarnaServer.Beta or API.KlarnaServer.Live, depending
// on which server your eid is associated with
Mode = API.KlarnaServer.Beta,
PCStorage = "xml",
PCURI = @"/tmp/pclasses.xml"
});
2. Return an amount of a invoice as discount
//Use the invoicenumber recieved from AddTransAction()
string invoicenr = "";
try {
string invoice = klarna.ReturnAmount (
invoicenr,
19.99, //Amount given as discount
25, //VAT in %
API.Flag.IncVAT //Amount including VAT
);
//Discount given, proceed accordingly. The result now holds the invoice number of the discounted invoice
Console.WriteLine (invoice);
} catch (Exception e) {
//Something went wrong, print the error:
Console.WriteLine ("Error: " + e.Message);
}
The code examples have been divided into several steps. Click on the step you would like to see the code example.
1. Initialize and setup the Klarna instance
Klarna k = new Klarna();
/*
* Configure the Klarna object using the config() method. (Alternative 1)
*/
/* KlarnaConfig conf = new KlarnaConfig();
// Define values:
conf.setEid(0); // Merchant ID or Estore ID, an Integer above 0.
conf.setSecret("sharedSecret"); // The shared secret which accompanied your eid.
conf.setCountry(KlarnaCountry.DE); // The country of your store.
conf.setLanguage(KlarnaLanguage.DE); // The language of your store.
conf.setCurrency(KlarnaCurrency.EUR); // The currency of your store.
conf.setMode(Klarna.BETA); // or Klarna.LIVE when you are ready to go live.
// Define pclass settings:
conf.setPcStorage("json"); // Storage module. Currently only json is supported.
conf.setPcURI("/srv/pclasses.json"); // Where the json file for the pclasses are stored.
// Should we use SSL?
conf.setSsl(false);
// Should we error report/status report to klarna.
conf.setCandice(true); // set to false if your server doesn't support UDP
// Do we want to see normal debug information?
conf.setDebug(null); // true to debug, null or false not to debug
// Set the config object.
k.config(conf);
*/
/*
* Configure the Klarna object using the config() method (Alternative 2)
*/
/*
* k.config(0, // e-store ID
* "sharedSecret", // shared secret
* KlarnaCountry.DE, // Country constant
* KlarnaLanguage.DE, // Language constant
* KlarnaCurrency.EUR, // Currency constant
* Klarna.BETA, // Mode, BETA or LIVE
* "json", // Storage module
* "/srv/pclasses.json", // Storage location
* true, // SSL
* true // Candice
* );
*
* k.debug = false;
*/
/*
* Configure the Klarna object using the config() method (Alternative 3)
*/
k.config(KlarnaConfig.fromJson("/srv/klarna.json"));
/* the file would contain the following data to set the same information as above alternatives:
* {
* "eid":0,
* "secret":"sharedSecret",
* "country":"DE",
* "language":"DE",
* "currency":"EUR",
* "mode":1,
* "ssl":false,
* "candice":true,
* "pcStorage":"json",
* "pcURI":"/srv/pclasses.json"
* }
*
*/
2. Give a discount on the invoice
// Here you enter the Invoice number:
String invNo = request.getParameter("invoice_number");
try {
String result = k.returnAmount(
invNo,
19.99, // Amount given as a discount
19d, // 19% VAT
KlarnaFlags.Goods.INC_VAT.intVal()); // Amount includes VAT
/* Discount given, proceed accordingly.
* result contains the invoice number of the discounted invoice. */
} catch (Exception e) {
// Something went wrong, print the message.
out.println(e.getMessage());
}
The code examples have been divided into several steps. Click on the step you would like to see the code example.
1. Initialize and setup the Klarna instance
<%
Option Explicit
%>
<%
' Grab the API object
' -Merchant ID or Estore ID, an integer above 0.
' -The shared secret which accompanied your eid.
' -Country, language and currency.
Dim kAPI
Set kAPI = GetKlarna(0, "sharedsecret", "SE", "SV", "SEK")
' Do we want to see normal debug information?
kAPI.DebugInformation = True
' Set the address and port to Klarna server.
' Use LIVE or BETA depending on which server your eid is associated with.
kAPI.SetPort(HTTPS_PORT) ' or HTTP_PORT
kAPI.SetHost(BETA_HOST) ' or LIVE_HOST
' Where the XML for the PClasses are stored, e.g. "pclasses.xml"
kAPI.SetPClassesStorageUri(Server.MapPath("pclasses.xml"))
%>
2. Give a discount on the invoice
<%
On Error Resume Next
' Here you enter the reservation number you got from ReserveAmount():
Dim invno
invno = CStr(Request.QueryString("invno"))
' -Invoice number
' -Amount, give 19.99 as a discount
' -VAT, 25% VAT
' -Flags, price including VAT
Dim result
result = kAPI.ReturnAmount(invno, 19.99, 25, INC_VAT)
If Err.number = 0 Then
' Success
' Discount given, proceed accordingly.
' result contains the invoice number of the discounted invoice.
Dim invoiceNumber
invoiceNumber = result(0)
Response.write ("Successfull discount in invoice #" & result)
Else
' Something went wrong
Response.Write("Error occured: " & Err.number & " - " & Err.Description & "" & Err.Source & "")
End If
%>