creditPart

Purpose:

creditPart is a partial refund on an invoice, part payment or mobile purchase.

Return value:

String - Invoice number for the partly returned 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. Partially refund a invoice
// Here you enter the invoice number:
$invNo = '123456';

// Specify for which article(s) you want to refund.
$k->addArtNo(
    1,          // Quantity
    'MG200MMS'  // Article Number. Must be the same as the one you used
);              // in addArticle() when you made the addTransaction() call.

try {
    $result = $k->creditPart(
        $invNo,   // Invoice Number
        ''        // Credit Number. (Optional).
    );

    echo "Result: {$result}\n";

    /* Invoice partially refunded, proceed accordingly.
       $result contains the invoice number of the refunded 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. Partially refund a invoice
            //Use the invoice number you wich to refund
            string invoicenr = "";

            //Specify for which article(s) you want to refund:
            klarna.AddArticleNumber (
                1,
            // ArtNo must be the same as the one you used for AddArticle() when
            // you made the AddTransaction call.
                "1234e"
            );

            try {
                string result = klarna.CreditPart (
                    invoicenr,
                // Credit number. If you don't want to use credit numbers, leave empty
                    ""
                );

                //Invoice partially refunded, proceed accordinglys
                //result contains the invoice number of the refunded invoice
                Console.WriteLine (result);
            } 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. Partially refund a invoice
    //  Here you enter the invoice number.
    String invNo = request.getParameter("invoice_number");

    // Specify for which article(s) you want to refund.
    k.addArtNo(1, "MG200MMS");  // artNo must be the same as the one you used in addArticle() when you made the addTransaction() call.

    try {
        String result = k.creditPart(
                invNo,
                ""); // If you don't want to use credit numbers, leave the parameter out.

        // Invoice partially refunded, proceed accordingly.
        // result contains the invoice number of the refunded 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. Partially refund a invoice
<%

    On Error Resume Next

    ' Here you enter the invoice number:
    Dim invno
    invno = CStr(Request.QueryString("invno"))

    ' Specify for which article(s) you want to refund.
    ' -Quantity
    ' -Article number, must be the same as the one you used in addArticle() when you made the addTransaction call.
    Call kAPI.AddArticleNumber(1, "MG200MMS") 

    ' -Invoice number
    ' -Credit number, if you don't want to use credit numbers, leave empty.
    Dim result
    result = kAPI.CreditPart(invno, "") 

    If Err.number = 0 Then
        ' Success
    
        ' Invoice fully refunded, proceed accordingly.
        ' result now containts the invoice number of the refunded invoice.
        Response.Write("
Invoice "& result & " was succesfully refunded
") Else ' Something went wrong Response.Write("Error occured: " & Err.number & " - " & Err.Description & "
" & Err.Source & "
") End If %>

Input data:

Variable Type Description
required eidintegerAn e-store ID which refers to your store in Klarna's database
required invnostringThe active invoice number
required artnoslistA list of pairs containing quantity and article number to be credited. Each element in the list is created using a call to the addArtNo function.
crednostringCredit number. If you do not wish to use credit numbers, send empty string.
required secretstringA shared secret used to secure all traffic exchanged by Klarna and your store