Get Installment Plans

API Reference

This page provides API reference for Velocity API's Get Installment Plans operation. This operation is available for credit card transactions; it is not applicable to wallet integration. For information on how to integrate this operation, see API and our Installments integration guide.

Request

Endpoint: /crs/routingservice/get-installment-plans
Method: GET

Sample Request

Below is sample code for a Get Installment Plans request:

<?xml version="1.0" encoding="UTF-8"?>
<installment_plans_search_criteria>
    <transaction>
        <id>80306591</id>
        <amount>
            <value>290000</value>
            <country_id>405</country_id>
            <currency_id>170</currency_id>
        </amount>
        <card>
            <id>7</id>
            <type_id>7</type_id>
            <amount>
                <value>290000</value>
                <country_id>405</country_id>
                <currency_id>170</currency_id>
            </amount>
            <issuer_identification_number>53037104094</issuer_identification_number>
        </card>
    </transaction>
    <client_info>
        <platform>HTML5</platform>
        <language>en</language>
        <version>2.0.0</version>
        <mobile>
            <mobile>7676565454</mobile>
            <country_id>405</country_id>
            <mobile_type>MobileEnriched</mobile_type>
            <validated>true</validated>
        </mobile>
        <email>
            <email>[email protected]</email>
            <email_type>EmailEnriched</email_type>
            <validated>true</validated>
        </email>
        <client_id>10101</client_id>
    </client_info>
</installment_plans_search_criteria>

Request Parameters

transaction

Parent: installment_plans_search_criteria

The transaction element is required, and it has three children: id, amount, and card.

The id child element has the following text content:

ParameterFormatRequirementDescription
transaction IDStringRequiredThe CellPoint Digital transaction ID of the transaction whose installment plans are being requested.

This is found in the Initialize response, as the value of the id attribute in <transaction>.

amount

Parents: installment_plans_search_criteria: transaction

The amount element in transaction is required, and it has the following children:

ElementRequirementFormat of text contentDescription of text content
valueRequiredIntegerThe total payment amount.
country_idRequiredIntegerThe numeric country ID of the total payment amount's currency.
currency_idOptionalIntegerThe numeric currency ID of the total payment amount's currency.

card

Parents: installment_plans_search_criteria: transaction

The card element is required, and it has the following children: id, type_id, amount, and issuer_identification_number.

The id child element has the following text content:

ParameterFormatRequirementDescription
card IDIntegerRequiredThe ID that indicates the type of card used for a transaction.

The type_id child element has the following text content:

ParameterFormatRequirementDescription
card type IDIntegerRequiredA number indicating the type of card used for the transaction. For example, 7 indicates Mastercard.

The amount child element is optional, and it has the following children:

ElementRequirementFormat of text contentDescription of text content
valueOptionalIntegerThe amount paid by this card for this transaction.
country_idOptionalIntegerThe numeric country ID of the card amount.
currency_idOptionalIntegerThe numeric currency ID of the card amount.

The issuer_identification_number child element has the following text content:

ParameterFormatRequirementDescription
issuer identification numberIntegerRequiredThe first 11 digits of the card BIN.

client_info

Parent: installment_plans_search_criteria

The client_info element is optional, and it has the following children: platform, language, version, mobile, email, and client_id. See their descriptions below.

platform

Parents: installment_plans_search_criteria: client_info

The platform element is optional, and it has the following text content:

ParameterFormatRequirementDescription
platformStringOptionalThe platform from which the request is sent. For example, web, iOS, Android, HTML, B2B, and B2C.

language

Parents: installment_plans_search_criteria: client_info

The language element is optional, and it has the following text content:

ParameterFormatRequirementDescription
languageStringOptionalThe language that Velocity uses as default when translating the payment pages.

Note: Velocity language codes are based upon the ISO- 639-1 standard.

Refer to https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes for details.

version

Parents: installment_plans_search_criteria: client_info

The version element is optional, and it has the following text content:

ParameterFormatRequirementDescription
versionStringOptionalThe version of the API or app that sends the request.

mobile

Parents: installment_plans_search_criteria: client_info

The mobile element is optional, and it has the following children:

ElementRequirementFormat of text contentDescription of text content
mobileConditional Requirement: Required if the mobile parent element is present.IntegerThe customer’s mobile number.
country_idOptionalIntegerThe CellPoint Digital-specific country code provided to merchants on request.
mobile_typeConditional Requirement: Required if the mobile parent element is present.StringMobileEnriched - this text is passed.
validatedConditional Requirement: Required if the mobile parent element is present.BooleanIf true, the mobile number has been validated.

email

Parents: installment_plans_search_criteria: client_info

The email element is optional, and it has the following children:

ElementRequirementFormat of text contentDescription of text content
emailConditional Requirement: Required if the email parent element is present.StringThe customer's email address. If a customer provides this, the email input field on the 'Send E-Mail Receipt' page is automatically populated with this value.
email_typeConditional Requirement: Required if the email parent element is present.StringEmailEnriched - this text is passed.
validatedConditional Requirement: Required if the email parent element is present.BooleanIf true, the email address has been validated.

client_id

Parents: installment_plans_search_criteria: client_info

The client_id element is optional, and it has the following text content:

ParameterFormatRequirementDescription
client IDIntegerRequiredA unique ID configured for a merchant on the Velocity POP.

Response

Sample Response with Installment Plans

The code below is a sample Get Installment Plans response that contains available installment plans.

<?xml version="1.0" encoding="UTF-8"?>
<root>
  <installment_plans_search_response>
    <installment_plans>
      <installment_plan>1</installment_plan>
      <installment_plan>2</installment_plan>
      <installment_plan>3</installment_plan>
      <installment_plan>4</installment_plan>
      <installment_plan>5</installment_plan>
      <installment_plan>6</installment_plan>
      <installment_plan>7</installment_plan>
      <installment_plan>8</installment_plan>
      <installment_plan>9</installment_plan>
      <installment_plan>10</installment_plan>
      <installment_plan>11</installment_plan>
      <installment_plan>12</installment_plan>
      <installment_plan>13</installment_plan>
      <installment_plan>14</installment_plan>
      <installment_plan>15</installment_plan>
      <installment_plan>16</installment_plan>
      <installment_plan>17</installment_plan>
      <installment_plan>18</installment_plan>
      <installment_plan>19</installment_plan>
      <installment_plan>20</installment_plan>
      <installment_plan>21</installment_plan>
      <installment_plan>22</installment_plan>
      <installment_plan>23</installment_plan>
      <installment_plan>24</installment_plan>
      <installment_plan>25</installment_plan>
      <installment_plan>26</installment_plan>
      <installment_plan>27</installment_plan>
      <installment_plan>28</installment_plan>
      <installment_plan>29</installment_plan>
      <installment_plan>30</installment_plan>
      <installment_plan>31</installment_plan>
      <installment_plan>32</installment_plan>
      <installment_plan>33</installment_plan>
      <installment_plan>34</installment_plan>
      <installment_plan>35</installment_plan>
      <installment_plan>36</installment_plan>
    </installment_plans>
  </installment_plans_search_response>
</root>

Sample Response with No Installment Plans

If no installment plans are available, the API returns an empty response like the sample shown below. (This may happen if no business rules are configured or matched for the specific transaction.)

<?xml version="1.0" encoding="UTF-8"?>
<root>
  <installment_plans_search_response>
    <installment_plans/>
  </installment_plans_search_response>
</root>

Response Parameters

installment_plans_search_response

Parent: root

Please note:

  • The installment_plans_search_response element has one child: installment_plans.
  • The installment_plans child element may have multiple installment_plan children.

Each installment_plan child has the following text content:

ParameterFormatRequirementDescription
installment planIntegerOptionalThe identifying number of an available installment plan. This indicates the number of months across which the installment payments are divided.