get-installment-plans
The Get Installment Plans operation returns different installment plans to the customer based on business rules. For example, offer installments only if the customer uses a Columbia Credit Card. Such rules are defined in the CellPoint Digital Business Rule module through the Vision portal. The rules can be based on various attributes such as card issuer country, card type, and card scheme.
The table below specifies the endpoint and request requirements for this operation:
| Name | Details |
|---|---|
| Endpoint | [ VELOCITY URL]/ crs/routingservice/get-installment-plans |
| Request Method | GET |
| Authentication | HTTP basic access authentication |
| Format/Content Type | text/xml |
Parameters
The description of the parameters is as follows:
| Parameter | Type | Required | Description |
|---|---|---|---|
| transaction-id | String | Yes | CPD Transaction ID for which status is being requested. |
| amount | Integer/ Amount | Yes | The total payment amount. |
| country-id | Integer | Yes | The country ID. |
| currency-id | Integer | No | The currency ID |
| issuer_identification_number | Integer | Yes | The first 11 digits of the card BIN. |
| card id | Integer | Yes | The ID which indicates the type of card used for a transaction. |
| card-type-id | Integer | Yes | An identification number to know the type of card used for a transaction. For example, 7 indicates Mastercard. |
client-info Parameters
client-info Parameters| Parameter | Type | Required | Description |
|---|---|---|---|
| client-info | String | No | The object which contains details of language used for a transaction, version, and platform details. |
| platform | String | No | The platform from which the request is sent. For example, web, iOS, Android, HTML, B2B, and B2C. |
| language | String | No | The 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 | String | No | The version of an API or app that sends the request. |
| mobile | Integer | Yes | The customer’s mobile number. Note: The mobile block can be skipped, but if selected the fields are mandatory as listed. |
| country-id | Integer | No | The CPD-specific country code provided to merchants on request. |
| mobile_type | String | Yes | “MobileEnriched” - this text is passed. |
| String | Yes | The email address of a customer. If a customer provides this parameter, the email input field on the Send E-Mail Receipt page is automatically populated with this value. | |
| email_type | String | Yes | “EmailEnriched” - this text is passed. |
| validated | String | Yes | Indicates whether the mobile/email has been verified or not. |
| client-id | Integer | Yes | A unique ID configured for a merchant on the Velocity POP. |
Request
The code below is an example of a Get Installment Plans request:
<?xml version="1.0" encoding="UTF-8"?>
<root>
<client-config account="[integer]" auto-capture="false" id="[integer]" mode="[integer]" store-card="[integer]">
<name>Test</name>
<callback-url>[callback url]</callback-url>
<accept-url />
</client-config>
<split_payment>
<configuration>
<applicable_combinations>
<combination>
<payment_type>
<id>1</id>
<sequence>1</sequence>
</payment_type>
<payment_type>
<id>2</id>
<sequence>2</sequence>
</payment_type>
<is_one_step_authorization>true</is_one_step_authorization>
</combination>
<combination>
<payment_type>
<id>1</id>
<sequence>1</sequence>
</payment_type>
<payment_type>
<id>1</id>
<sequence>2</sequence>
</payment_type>
<is_one_step_authorization>false</is_one_step_authorization>
</combination>
</applicable_combinations>
</configuration>
</split_payment>
<transaction auto-capture="true" eua-id="[integer]" id="[integer]" language="en" mode="1" order-no="" type-id="[integer]">
<amount country-id="[integer]" currency="DKK" format="{PRICE} {CURRENCY}" symbol="">10025</amount>
<mobile country-id="[integer]" operator-id="[integer]">30206172</mobile>
<callback-url>[CALLBACK URL]</callback-url>
<accept-url />
</transaction>
<cards>
<card cvc-length=“3” cvcmandatory=“false” dcc=“false” enabled=“true” id=“8” instalment=“0" max-length=“19” min-length=“13" payment-type=“1” preferred=“false” processor-type=“1” psp-id=“21" state-id=“1” type-id=“8">
<name>Visa</name>
<prefixes>
<prefix>
<min>4000</min>
<max>4999</max>
</prefix>
<prefix>
<min>413222</min>
<max>413222</max>
</prefix>
</prefixes>Visa</card>
<card id="28" type-id="28" psp-id="24" min-length="-1" max-length="-1" cvc-length="-1" state-id="1" payment-type="4" preferred="false" enabled="true" processor-type="4" installment="0" cvcmandatory="false" dcc="true" presentment-currency="false">
<name>[PSP]</name>
<prefixes>
<prefix>
<min>0</min>
<max>0</max>
</prefix>
</prefixes>[PSP name]
</card>
</cards>
<vouchers>
<card id="26" type-id="26" psp-id="-1" min-length="-1" max-length="-1" cvc-length="-1" state-id="1" payment-type="2" preferred="false" enabled="true" processor-type="2" installment="0" cvcmandatory="false" dcc="false" presentment-currency="false">
<name>TravelFund</name>
<prefixes>
<prefix id="337">
<min>-1</min>
<max>-1</max>
</prefix>
</prefixes>TravelFund
</card>
</vouchers>
</root>
Response
The code below is an example of Get Installment Plans response:
<?xml version="1.0" encoding="UTF-8"?>
<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_plans>
</installment_plans_search_response>
If no installment plans are applicable (for example, no business rule are configured or matched for the specific transaction), the API returns an empty response like the sample shown below:
<installment_plans_search_response>
<installment_plans/>
</installment_plans_search_response>
Updated 3 months ago