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:

Parameter	Format	Requirement	Description
transaction ID	String	Required	The 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:

Element	Requirement	Format of text content	Description of text content
`value`	Required	Integer	The total payment amount.
`country_id`	Required	Integer	The numeric country ID of the total payment amount's currency.
`currency_id`	Optional	Integer	The 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:

Parameter	Format	Requirement	Description
card ID	Integer	Required	The ID that indicates the type of card used for a transaction.

The type_id child element has the following text content:

Parameter	Format	Requirement	Description
card type ID	Integer	Required	A 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:

Element	Requirement	Format of text content	Description of text content
`value`	Optional	Integer	The amount paid by this card for this transaction.
`country_id`	Optional	Integer	The numeric country ID of the card amount.
`currency_id`	Optional	Integer	The numeric currency ID of the card amount.

The issuer_identification_number child element has the following text content:

Parameter	Format	Requirement	Description
issuer identification number	Integer	Required	The 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.