Available Installment Plans

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

Path

POST /api/v3/lookup/installment-plans

Request Body

application/json

amount

required

number

Total order amount

currency

string

Enum:

Currency

countryCode

string

Enum:

Country code

Responses

array

Available installment plans

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 only

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
Max length: 2048

More information on installment process
type

string

Enum:
BusinessError
TechnicalError
NotificationMessage
code

string
Max length: 100

Confirmation or error code

message

string
Max length: 4096

Message content

customerFacingMessage

string
Max length: 4096

Message to display to customer
actionCode

string

Enum:
Unavailable
AskConsumerToConfirm
AskConsumerToReEnterData
OfferSecurePaymentMethods
RequiresSsn
AskConsumerToIdentify
ManualReview

Action codes
fieldReference

string
Max length: 100

Reference to field that caused an error
401 Authorization has been denied for this request.
413 Request body too large.
429 Too many requests.
500 Internal server error.

Successful Request

Request Example

    
        {
 "amount": 185,
 "currency": "EUR",
 "countryCode": "DE"
}

Response Example

    
        {
 "availableInstallmentPlans": [
  {
   "monthlyFee": 0,
   "startupFee": 0,
   "totalAmount": 185,
   "basketAmount": 185,
   "interestRate": 0,
   "installmentAmount": 61.67,
   "totalInterestAmount": 0,
   "numberOfInstallments": 3,
   "effectiveInterestRate": 0,
   "lastInstallmentAmount": 61.66,
   "firstInstallmentAmount": 61.67,
   "installmentProfileNumber": 1,
   "effectiveAnnualPercentageRate": 0
  },
  {
   "monthlyFee": 0,
   "startupFee": 0,
   "totalAmount": 185,
   "basketAmount": 185,
   "interestRate": 0,
   "installmentAmount": 30.84,
   "totalInterestAmount": 0,
   "numberOfInstallments": 6,
   "effectiveInterestRate": 0,
   "lastInstallmentAmount": 30.8,
   "firstInstallmentAmount": 30.84,
   "installmentProfileNumber": 2,
   "effectiveAnnualPercentageRate": 0
  },
  {
   "monthlyFee": 0,
   "startupFee": 0,
   "totalAmount": 185,
   "basketAmount": 185,
   "interestRate": 0,
   "installmentAmount": 20.56,
   "totalInterestAmount": 0,
   "numberOfInstallments": 9,
   "effectiveInterestRate": 0,
   "lastInstallmentAmount": 20.52,
   "firstInstallmentAmount": 20.56,
   "installmentProfileNumber": 3,
   "effectiveAnnualPercentageRate": 0
  }
 ]
}