Financing

Use the Financing API to get financing information for a specific product. A shopper can use financing to pay for a product over time.

Financing can be activated as a payment method within DRCC/BigBlue. When a shopper checks out, they can choose the finance option as a payment method for specific products.

To associate a product in a cart with finance terms for the product, use POST /shoppers/me/carts/active?productId={pid}&termId={termId}. See POST /shoppers/me/carts for more information.

Methods


					Host: api.digitalriver.com
Accept: application/json
Authorization: bearer your_access_token
User-Agent: Apache-HttpClient/4.5.2 (Java/1.8.0_102)
			
					The request body should be empty.
			
					HTTP/1.1 200 OK
			
					{"financing": {
   "uri": "https://api.digitalriver.com/v1/shoppers/me/products/55555555/financing",
   "financingTerm": [   {
      "id": 99999999,
      "totalRepayable":       {
         "currency": "USD",
         "value": 7.6
      },
      "formattedTotalRepayable": "$7.60",
      "creditAmount":       {
         "currency": "USD",
         "value": 7.2
      },
      "formattedCreditAmount": "$7.20",
      "monthlyPaymentAmount":       {
         "currency": "USD",
         "value": 0.64
      },
      "formattedMonthlyPaymentAmount": "$0.64",
      "durationInMonths": 12,
      "interestRatePct": 0.099,
      "interestRatePctForDisplay": 9.9,
      "description": "9.9% for 12 months"
   }]
}}
			

Response Body Parameters

Fields Data Type Visibility Description
creditAmount structured expand The credit amount.
creditAmount.currency string default The shopper's preferred currency.
creditAmount.value decimal default The credit amount value.
description string default Describes the terms of the financing.
durationInMonths integer default The duration of the financing in months.
financingTerm structured default The terms of the financing.
formattedCreditAmount string default The credit amount in locale currency format.
formattedMonthlyPaymentAmount string default The monthly payment amount in locale currency format.
formattedTotalRepayable string default The total repayable amount in locale currency format.
id string default The financing ID.
interestRatePct decimal default The interest rate.
interestRatePctForDisplay decimal default The displayed interest rate.
monthlyPaymentAmount structured expand The montly payment amount.
monthlyPaymentAmount.currency
string default The shopper's preferred currency.
monthlyPaymentAmount.value
decimal default The monthly payment amount value.
totalRepayable structured expand The total repayable amount.
totalRepayable.currency string default The shopper's preferred currency.
totalRepayable.value decimal default The total repayable amount value.