PAN

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.

PAN Information

To include the customer's PAN in the request, set the
paymentInformation.card.number
 field to the customer's card number.

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 PAN

Optional Field for Installment Services

You may include this optional field when requesting an installment service.

REST API
 Example: Get Installment Plans with a PAN

Light Dark
Request
1234567891011121314
{"processingInformation": {
    "installmentServiceProvider": "Visa"
  },
  "paymentInformation": {
    "card": {
      "number": "4622943127019793"
    }
  },
  "orderInformation": {
    "amountDetails": {
      "totalAmount": "500",
      "currency": "USD"
    }
  }}
Response to Successful Request
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107
{"id": "7103624818226565203955",
  "submitTimeUtc": "2024-03-13T20:41:21Z",
  "status": "ACCEPTED",
  "processorInformation": {
    "responseCode": "200"
  },
  "paymentInformation": {
    "paymentAccountReference": {
      "id": "V0010013021015314796935636599"
    }
  },
  "installmentInformation": {
    "planDetails": [
      {
        "planId": "2880acde-0166-c2cd-2ceb-163061cdb601",
        "identifier": "0000000024",
        "planName": "Plan6M",
        "planType": "ISSUER_PROMOTION",
        "totalCount": "6",
        "frequency": "MONTHLY",
        "promotionId": "06216M1",
        "amountDetails": {
          "lastInstallmentAmount": "83.30",
          "totalFeeAmount": "0.00",
          "totalUpfrontFeeAmount": "0.00",
          "totalRecurringFeeAmount": "0.00",
          "totalPlanAmount": "500.00",
          "interestRate": "0.00",
          "fees": [
            {
              "type": "CONSUMER",
              "ratePercentage": "0.00",
              "flatFeeAmount": "0.00"
            },
            {
              "type": "CONSUMER_UPFRONT",
              "ratePercentage": "0.00",
              "flatFeeAmount": "0.00"
            }
          ],
          "firstInstallment": {
            "feeAmount": "0.00",
            "amount": "83.34",
            "upfrontFeeAmount": "0.00"
          },
          "lastInstallment": {
            "feeAmount": "0.00",
            "amount": "83.30"
          }
        },
        "termsAndConditions": [
          {
            "tncUrl": "https://usa.visa.com",
            "version": "1",
            "text": "You are selecting a 6-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 APR calculated for 6 months. If you miss an installment payment, the standard rate of purchases will apply to the remaining installment balance.",
            "languageCode": "eng"
          }
        ]
      },
      {
        "planId": "14cfe0cd-345f-c6b6-f258-12c90c97c401",
        "identifier": "0000000025",
        "planName": "Plan12M",
        "planType": "ISSUER_DEFAULT",
        "totalCount": "12",
        "frequency": "MONTHLY",
        "promotionId": "062112M1",
        "amountDetails": {
          "lastInstallmentAmount": "41.63",
          "totalFeeAmount": "25.00",
          "totalUpfrontFeeAmount": "0.00",
          "totalRecurringFeeAmount": "25.00",
          "totalPlanAmount": "525.00",
          "interestRate": "0.00",
          "fees": [
            {
              "type": "CONSUMER",
              "ratePercentage": "5.00",
              "flatFeeAmount": "0.00"
            },
            {
              "type": "CONSUMER_UPFRONT",
              "ratePercentage": "0.00",
              "flatFeeAmount": "0.00"
            }
          ],
          "firstInstallment": {
            "feeAmount": "2.08",
            "amount": "41.67",
            "upfrontFeeAmount": "0.00"
          },
          "lastInstallment": {
            "feeAmount": "2.12",
            "amount": "41.63"
          }
        },
        "termsAndConditions": [
          {
            "tncUrl": "https://usa.visa.com",
            "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 APR calculated for 12 months. If you miss an installment payment, the standard rate of purchases will apply to the remaining installment balance.",
            "languageCode": "eng"
          }
        ]
      }
    ]
  }}