Token

The
get installment plans
 API request provides a complete list of eligible installment offers to a customer during checkout. This request validates the eligibility of a payment transaction for installment plans and verifies participating issuer conditions for eligibility. For example, the request verifies the minimum and maximum plan amount.
When you retrieve installment plans, these conditions apply:
  • A successful response includes one or more eligible installment plans.
  • If no active plans match the set of criteria, the response returns an empty array.
  • Plans that are expired or plans that expire within the next 24 hours are not returned in the response.

Token Information

Include the token information in the service request with one of these token identifier fields:
  • Flex API Transient token:
    tokenInformation.transientTokenJwt
  • TMS
     Customer token:
    paymentInformation.customer.id
  • TMS
     Instrument Identifier token:
    paymentInformation.instrumentIdentifier.id
  • TMS
     Payment Instrument token:
    paymentInformation.paymentInstrument.id
  • TMS
     Transient token:
    tokenInformation.jti
For more information about token types, see the Token Types section in the
Token Management Service
 Developer Guide
.

Endpoint

Production
:
POST
https://api.cybersource.com
/fin/v1/plans/
Test
:
POST
https://apitest.cybersource.com
/fin/v1/plans/

Successful Response

A successful response includes these fields and values that you will need to store for follow-on API requests:
The field value is the
plan registration system identifier
. Certain countries require you to include the plan registration system identifier in the
installmentInformation.planDetails[].identifier
 field when you send the initial authorization request. Contact your
Cybersource
 account manager for more information.
installmentInformation.planDetails[].planId
The field value is the plan ID. Include the plan ID in the
installmentInformation.planId
 field when you send a select installment plan API request.

Required Fields for Getting Installment Plans with a Token

REST API
 Example: Get Installment Plans with a Token

Light Dark
Request
1234567891011121314
{"processingInformation": {
    "installmentServiceProvider": "Visa"
  },
  "paymentInformation": {
    "instrumentIdentifier": {
      "id": "7030000000012249793"
    }
  },
  "orderInformation": {
    "amountDetails": {
      "totalAmount": "500",
      "currency": "USD"
    }
  }}
Response
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192
{"id": "7103630803156444803955",
  "submitTimeUtc": "2024-03-13T20:51:20Z",
  "status": "ACCEPTED",
  "processorInformation": {
    "responseCode": "200"
  },
  "paymentInformation": {
    "paymentAccountReference": {
      "id": "V0010013020261601352183794986"
    }
  },
  "installmentInformation": {
    "planDetails": [
      {
        "planId": "49ae7aa2-68ec-5f33-fd51-12fd51a2a601",
        "identifier": "000000000K",
        "planName": "WithManyFees",
        "planType": "ISSUER_PROMOTION",
        "totalCount": "2",
        "frequency": "BIWEEKLY",
        "amountDetails": {
          "lastInstallmentAmount": "250.00",
          "totalFeeAmount": "18.00",
          "totalUpfrontFeeAmount": "6.00",
          "totalRecurringFeeAmount": "12.00",
          "totalPlanAmount": "518.00",
          "interestRate": "0.00",
          "fees": [
            {
              "type": "CONSUMER",
              "ratePercentage": "2.00",
              "flatFeeAmount": "2.00"
            },
            {
              "type": "CONSUMER_UPFRONT",
              "ratePercentage": "0.00",
              "flatFeeAmount": "6.00"
            }
          ],
          "firstInstallment": {
            "feeAmount": "12.00",
            "amount": "250.00",
            "upfrontFeeAmount": "6.00"
          },
          "lastInstallment": {
            "feeAmount": "6.00",
            "amount": "250.00"
          }
        },
        "termsAndConditions": [
          {
            "version": "1",
            "text": "This is just another Test",
            "languageCode": "eng"
          }
        ]
      },
      {
        "planId": "a811fe1f-2627-cde9-29b7-1a19577f0901",
        "identifier": "000000001K",
        "planName": "ConsumerTestPlan1",
        "planType": "ISSUER_PROMOTION",
        "totalCount": "12",
        "frequency": "MONTHLY",
        "amountDetails": {
          "lastInstallmentAmount": "41.63",
          "totalFeeAmount": "0.00",
          "totalUpfrontFeeAmount": "0.00",
          "totalRecurringFeeAmount": "0.00",
          "totalPlanAmount": "500.00",
          "interestRate": "10.00",
          "fees": [
            {
              "type": "CONSUMER",
              "ratePercentage": "0.00",
              "flatFeeAmount": "0.00"
            },
            {
              "type": "CONSUMER_UPFRONT",
              "ratePercentage": "0.00",
              "flatFeeAmount": "0.00"
            }
          ],
          "firstInstallment": {
            "feeAmount": "0.00",
            "amount": "41.67",
            "upfrontFeeAmount": "0.00"
          },
          "lastInstallment": {
            "feeAmount": "0.00",
            "amount": "41.63"
          }
        },
        "termsAndConditions": [
          {
            "version": "1",
            "text": "You are selecting a 12 month installment plan. The total purchase amount will be deducted from your available credit limit. As set forth in your terms, your installment fee will be 10% APR for 12 months. If you miss an installment payment, the standard rate for purchases will apply to the remaining installment balance.",
            "languageCode": "eng"
          }
        ]
      },
      {
        "planId": "9b6a2573-f532-2779-1cd2-1f054fdf9001",
        "identifier": "000000002K",
        "planName": "BilarterConsumerPlan1",
        "planType": "ISSUER_PROMOTION",
        "totalCount": "12",
        "frequency": "MONTHLY",
        "promotionId": "123",
        "amountDetails": {
          "lastInstallmentAmount": "41.63",
          "totalFeeAmount": "55.00",
          "totalUpfrontFeeAmount": "30.00",
          "totalRecurringFeeAmount": "25.00",
          "totalPlanAmount": "555.00",
          "interestRate": "0.00",
          "fees": [
            {
              "type": "CONSUMER",
              "ratePercentage": "5.00",
              "flatFeeAmount": "0.00"
            },
            {
              "type": "CONSUMER_UPFRONT",
              "ratePercentage": "6.00",
              "flatFeeAmount": "0.00"
            }
          ],
          "firstInstallment": {
            "feeAmount": "32.08",
            "amount": "41.67",
            "upfrontFeeAmount": "30.00"
          },
          "lastInstallment": {
            "feeAmount": "2.12",
            "amount": "41.63"
          }
        },
        "termsAndConditions": [
          {
            "version": "1",
            "text": "blah blah",
            "languageCode": "tel"
          }
        ]
      },
      {
        "planId": "23e950ef-021b-ca06-a797-11c7456c5201",
        "identifier": "00000000RN",
        "planName": "CybersourcePlanArabic",
        "planType": "ISSUER_DEFAULT",
        "totalCount": "12",
        "frequency": "MONTHLY",
        "amountDetails": {
          "lastInstallmentAmount": "41.63",
          "totalFeeAmount": "0.00",
          "totalUpfrontFeeAmount": "0.00",
          "totalRecurringFeeAmount": "0.00",
          "totalPlanAmount": "500.00",
          "interestRate": "0.00",
          "fees": [
            {
              "type": "CONSUMER_UPFRONT",
              "ratePercentage": "0.00",
              "flatFeeAmount": "0.00"
            },
            {
              "type": "CONSUMER",
              "ratePercentage": "0.00",
              "flatFeeAmount": "0.00"
            }
          ],
          "firstInstallment": {
            "feeAmount": "0.00",
            "amount": "41.67",
            "upfrontFeeAmount": "0.00"
          },
          "lastInstallment": {
            "feeAmount": "0.00",
            "amount": "41.63"
          }
        },
        "termsAndConditions": [
          {
            "version": "2",
            "text": "أنت تختار خطة التقسيط لمدة 12 شهرًا مع رسوم أو رسوم تمويل تبلغ 13.99% من إجمالي مبلغ الشراء - تم الكشف عنها على أنها \"رسوم\" أعلاه. دفعة خطة التقسيط الشهرية هي إجمالي مبلغ الشراء بالإضافة إلى الرسوم، وكلها مقسمة بالتساوي على عدد x من دورات الفوترة. سيتم تضمين أول دفعة شهرية لخطة التقسيط كجزء من الحد الأدنى للدفعة في كشف حسابك التالي. يرجى الرجوع إلى اتفاقية حامل البطاقة الخاصة بك لمعرفة عواقب عدم سداد دفعات خطة التقسيط. إذا تم سداد أي خطة تقسيط مبكرًا، فلن يتم تقييم جزء الرسوم المرتبط بالأشهر التالية للدفع",
            "languageCode": "ara"
          }
        ]
      }
    ]
  }}