Home > API > Product > Available installment plans

Available installment plans

Returns the available installment plans for the specific product/basket value. Returns monthly installment amount, interest and fees. Typically used on a product page.

PATH:

/api/v3/lookup/installment-plans

REQUEST BODY SCHEMA:

amount
required

number

Total order amount

currency

string

Enum: EUR NOK SEK DKK CHF

undefined

countryCode

string

Enum: NO SE FI DK DE AT CH NL BE

undefined

RESPONSES:

200 OK

RESPONSE SCHEMA:

availableInstallmentPlans

array of availableInstallmentPlans

Available installment plans

Array () [
basketAmount

number

Basket amount

numberOfInstallments

integer

Number of installments

installmentAmount

number

Monthly installment amount

firstInstallmentAmount

number

Amount of the first installment payment

lastInstallmentAmount

number

Amount of the last installment payment

interestRate

number

Interest rate

effectiveInterestRate

number

Effective interest rate

effectiveAnnualPercentageRate

number

Effective annual percentage rate

totalInterestAmount

number

Total interest amount

startupFee

number

Fee for opening up an installment plan

monthlyFee

number

Monthly fee for the installment amount

totalAmount

number

Total amount

installmentProfileNumber

integer

Installment profile number

readMore

string <= 2048 characters

More information on installment process


]
400 Model validation failed.

RESPONSE SCHEMA:

Array () [
type

string

Enum: BusinessError TechnicalError NotificationMessage

Message type

code

string <= 100 characters

Confirmation or error code

message

string <= 4096 characters

Message content

customerFacingMessage

string <= 4096 characters

Message to display to customer

actionCode

string

Enum: Unavailable AskConsumerToConfirm AskConsumerToReEnterData OfferSecurePaymentMethods RequiresSsn AskConsumerToIdentify

Possible next action to make

fieldReference

string <= 100 characters

Reference to field that caused an error

]
401 Authorization has been denied for this request.
500 Internal server error.

Path

post

/api/v3/lookup/installment-plans

Request samples

  • {
    • "amount": 1.00,
    • "currency": "string",
    • "countryCode": "string"
  • }

Response samples

200400
  • {
    • "availableInstallmentPlans": [ ...
      • {
        • "basketAmount": 1.00,
        • "numberOfInstallments": 1,
        • "installmentAmount": 1.00,
        • "firstInstallmentAmount": 1.00,
        • "lastInstallmentAmount": 1.00,
        • "interestRate": 1.00,
        • "effectiveInterestRate": 1.00,
        • "effectiveAnnualPercentageRate": 1.00,
        • "totalInterestAmount": 1.00,
        • "startupFee": 1.00,
        • "monthlyFee": 1.00,
        • "totalAmount": 1.00,
        • "installmentProfileNumber": 1,
        • "readMore": "string"
        }
      ]
    }
  • [
      ...
      • {
        • "type": "string",
        • "code": "string",
        • "message": "string",
        • "customerFacingMessage": "string",
        • "actionCode": "string",
        • "fieldReference": "string"
        }
    ]