Retrieve installments
Overview
Use the getInstallments method to retrieve information about the number of installments available for a specific selection of product/services.
Supported payment methods
Credit/Debit cards: local Visa and MasterCard Brazilian cards.
Parameters
Parameters | Type/Description |
---|---|
sessionID |
String / Required |
|
Session identifier, the output of the Login method. Include sessionID into all your requests. 2Checkout throws an exception if the values are incorrect. The sessionID expires in 10 minutes. |
Object / Required | |
|
Object designed to collect all data necessary for an order, including billing, product/subscription plan and payment details. |
Response
Parameters | Type/Description | |
---|---|---|
InstallmentsOption |
Array of objects |
|
|
Details below. |
|
|
Number |
Int |
|
|
Number of installments. |
|
Amount |
Double |
|
|
Standalone installment value. (Total order value/Number of installments) |
|
Currency |
String |
|
|
Order currency. |
Request
<?php require ('PATH_TO_AUTH'); $Order = new stdClass(); $Order->RefNo = null; $Order->Currency = 'brl'; $Order->Country = 'BR'; $Order->Language = 'en'; $Order->CustomerIP = '91.220.121.21'; $Order->ExternalReference = null; $Order->Source = null; $Order->AffiliateId = null; $Order->CustomerReference = null; $Order->Items = array(); $Order->Items[0] = new stdClass(); $Order->Items[0]->Code = 'my_subscription_1'; $Order->Items[0]->Quantity = 1; $Order->Items[0]->PriceOptions = null; $Order->BillingDetails = new stdClass(); $Order->BillingDetails->FirstName = 'FirstName'; $Order->BillingDetails->LastName = 'LastName'; $Order->BillingDetails->CountryCode = 'BR'; $Order->BillingDetails->State = 'DF'; $Order->BillingDetails->City = 'LA'; $Order->BillingDetails->Address1 = 'Address example'; $Order->BillingDetails->Address2 = null; $Order->BillingDetails->Zip = '70403-900'; $Order->BillingDetails->Email = 'customer@email.com'; $Order->BillingDetails->Phone = "556133127400"; $Order->BillingDetails->FiscalCode = "056.027.963-98"; $Order->BillingDetails->Company = null; $Order->DeliveryDetails = null; $Order->PaymentDetails = new stdClass (); $Order->PaymentDetails->Type = 'CC'; $Order->PaymentDetails->Currency = 'brl'; $Order->PaymentDetails->PaymentMethod = new stdClass (); $Order->PaymentDetails->CustomerIP = '10.10.10.10'; $Order->PaymentDetails->PaymentMethod->RecurringEnabled = true; $Order->PaymentDetails->PaymentMethod->CardNumber = "4111111111111111"; $Order->PaymentDetails->PaymentMethod->CardType = 'visa'; $Order->PaymentDetails->PaymentMethod->ExpirationYear = '2019'; $Order->PaymentDetails->PaymentMethod->ExpirationMonth = '12'; $Order->PaymentDetails->PaymentMethod->HolderName = 'John'; $Order->PaymentDetails->PaymentMethod->CCID = '123'; try { $OrderInstallments = $client->getInstallments($sessionID, $Order); } catch (SoapFault $e) { echo "Order_Installments: " . $e->getMessage(); exit; } var_dump("Order_Installments", $OrderInstallments);