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
Empty-N/AIntentionally left empty.

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.

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.

Calculation Examples

For example, assume you have a product that costs 129 SEK and you want to display the minimum monthly payment for a payment plan.

Steps:

  • Run a GetPaymentPlanParamsEu request to retrieve the campaign values.
  • Filter the possible payment plans by comparing the product price with the campaign's FromAmount and ToAmount.
  • In this case, the only valid campaign is:
<CampaignCodeInfo>
  <CampaignCode>999999</CampaignCode>
  <Description>Dela upp betalningen på 24 månader</Description>
  <PaymentPlanType>Standard</PaymentPlanType>
  <ContractLengthInMonths>24</ContractLengthInMonths>
  <MonthlyAnnuityFactor>0.050020791054524637</MonthlyAnnuityFactor>
  <InitialFee>0</InitialFee>
  <NotificationFee>29</NotificationFee>
  <InterestRatePercent>18.2</InterestRatePercent>
  <NrOfInterestFreeMonths>0</NrOfInterestFreeMonths>
  <NrOfPaymentFreeMonths>0</NrOfPaymentFreeMonths>
  <FromAmount>1</FromAmount>
  <ToAmount>30000</ToAmount>
</CampaignCodeInfo>
Last updated on