Skip to main content

Get Available Campaigns

GetPaymentPlanParamsEu​

This method retrieves information about all the campaigns that are associated with the current ClientId. Use this information to display details about the possible payment plan options to customers. The returned CampaignCode is used when creating a payment plan.

Input​

GetPaymentPlanParamsEuRequest​

FieldRTypeDescription
Amount-Decimal(Optional) If specified, calculates and includes EffectiveInterest for each returned campaign.

Output​

GetPaymentPlanParamsEuResponse​

FieldURTypeDescription
CampaignCodes*-Array of CampaignCodeInfo
ResultCode*-IntegerSee Result Code table

Structures​

CampaignCodeInfo​

FieldURTypeDescription
CampaignCode*-LongUnique id for this campaign.
Description--StringShort description of the campaign.
PaymentPlanType--PaymentPlanTypeCodeEnumeration defining what kind of campaign it is.
ContractLengthInMonths--IntegerTotal length of campaign.
MonthlyAnnuityFactor--DecimalHow much of the total sum is to be paid each payment.
InitialFee--DecimalStarting fee.
NotificationFee--DecimalRecurring fee for each payment.
InterestRatePercent--DecimalPayment plan interest.
NumberOfInterestFreeMonths--IntegerNumber of months before interest is added onto the payment plan.
NumberOfPaymentFreeMonths--IntegerNumber of months before the first payment.
FromAmount--DecimalLowest amount the campaign is valid for.
ToAmount--DecimalHighest amount the campaign is valid for.
EffectiveInterest--Decimal(Optional) Effective interest rate, calculated only if Amount was provided in the request

Enumerations​

PaymentPlanTypeCode​

ValueDescription
StandardA standard payment plan.
InterestFreeAn interest free payment plan.
InterestAndAmortizationFreeA payment plan where there is an initial payment and an interest free period.

GetAccountCreditParamsEu​

This method retrieves parameters related to account credit campaigns for the current client. It provides the available account credit campaign codes along with associated details to help determine account credit options.

Input​

GetAccountCreditParamsEuRequest​

FieldRTypeDescription
Empty-N/AIntentionally left empty.

Output​

GetAccountCreditParamsEuResponse​

FieldRTypeDescription
AccountCreditCampaignCodes-Array of AccountCreditCampaignCodeInfo
ResultCode-IntegerSee Result Code table

Structures​

AccountCreditCampaignCodeInfo​

FieldURTypeDescription
CampaignCode*-LongUnique id for this campaign.
Description--StringShort description of the campaign.
InitialFee--DecimalFee for placing account credit order.
LowestAmountToPayPerMonth--DecimalMinimum amount invoiced for this account credit campaign code.
LowestPercentToPayPerMonth--DecimalMinimum percent invoiced for this account credit campaign code.
LowestOrderAmount--DecimalLowest order amount to enable an account credit order to be placed.
InterestRatePercent--DecimalInterest rate in percent.
NotificationFee--DecimalRecurring fee for each payment.

Notes​

  • Note 1: For any given order, the hypothetical minimum amount to pay per month that should be presented to the customer is the larger of either LowestAmountToPayPerMonth or LowestPercentToPayPerMonth multiplied by the order total, provided that the order total also equals or exceeds LowestOrderAmount.
  • Note 2: The total account credit amount that will be invoiced each month is based not on a single order but on the total outstanding account credit for this customer and client (see BasicRequest). That is, the invoiced amount will be based on the sum of all outstanding account credit purchases for this customer and client.

Displaying Required Campaign Information​

Why Is This Required?​

Under the Swedish Consumer Credit Act (Konsumentkreditlagen), businesses offering credit must clearly present credit terms to the consumer before the purchase is completed. Svea Checkout handles this automatically, but as a merchant using our standalone integration you are responsible for presenting this information in your own checkout.

What Must Be Displayed​

There are four required sections:

  1. Campaign details — Dynamic values from the API and calculations.
  2. Konsumentverket credit warning — Static text.
  3. Consequences if the instalment plan is not followed — Semi-static text.
  4. Legal consent text — Static text with links.

1. Campaign Details​

When the customer selects an instalment plan, display the following details for the chosen campaign:

  • Setup fee
  • Administration fee
  • Annual interest rate
  • APR (Effective Interest)
  • Total cost

Use GetPaymentPlanParamsEu (instalment plans) or GetAccountCreditParamsEu (account credit) with the Amount parameter to retrieve campaign data. Refer to the GetPaymentPlanParamsEuResponse and GetAccountCreditParamsEuResponse sections for the full list of returned fields.

Dynamic Calculations​

The campaign API returns campaign terms such as campaign code, description, contract length, fees, interest rate, effective interest, and amount intervals. These fields can be displayed directly from the response.

Some displayed amounts, however, are purchase-specific and must be calculated dynamically using the current cart total together with the returned campaign terms.

For a typical instalment plan presentation, use the following formulas:

ValueCalculation
Monthly base amountpurchase amount × MonthlyAnnuityFactor
First-month amountmonthly base amount + NotificationFee + InitialFee
Recurring monthly amountmonthly base amount + NotificationFee
Total costInitialFee + (recurring monthly amount × ContractLengthInMonths)
Average monthly amounttotal cost ÷ ContractLengthInMonths

Fields taken directly from the API response should not be recalculated — display them as returned, applying only any necessary formatting. Calculated example amounts should always be based on the current purchase amount and may be rounded for display purposes.

2. Konsumentverket Credit Warning​

The following statutory warning must be displayed alongside the credit offer, including a warning symbol and a link to Konsumentverket:

⚠️ Att låna kostar pengar! Om du inte kan betala tillbaka skulden i tid riskerar du en betalningsanmärkning. Det kan leda till svårigheter att få hyra bostad, teckna abonnemang och få nya lån. För stöd, vänd dig till budget- och skuldrådgivningen i din kommun. Kontaktuppgifter finns på konsumentverket.se.

This is static text and must be displayed exactly as written. See Konsumentverket.se for detailed presentation requirements.

3. Consequences If the Instalment Plan Is Not Followed​

The following information about general terms must be displayed alongside fixed instalment plans. Replace the {placeholders} with the applicable values:

Vad händer om jag inte följer betalplanen?

De här villkoren gäller så länge du följer betalplanen. Om du betalar ett lägre belopp eller senare, börjar de generella villkoren att gälla, för närvarande {X} kr i månaden i administrationsavgift och {X,XX} % i rörlig årsränta.

Kostnadsexempel vid generella villkor

Om du handlar för 10 000 kr och betalar av det under 12 månader, innebär det en månadskostnad på {X} kr (totalt {X} kr), och den effektiva räntan blir {X,XX} %.

4. Legal Consent Text​

Display the following consent text prior to the customer confirming their purchase:

Genom att slutföra köpet godkänner du Sveas allmänna villkor, butikens köpvillkor ({YOUR_TERMS_URL}) och att dina uppgifter delas med butiken och den som ansvarar för leveransen av ditt köp. Du bekräftar också att du tagit del av Sveas dataskyddsinformation.

Replace {YOUR_TERMS_URL} with the URL to your own terms and conditions page.

Last updated on