---
title: "POST /api/InstallmentPlan/Initiate"
method: POST
path: "/api/InstallmentPlan/Initiate"
tags: ["InstallmentPlan"]
---

# POST /api/InstallmentPlan/Initiate

`POST /api/InstallmentPlan/Initiate`

## Headers

- `api-key` string
- `touch-point` string
- `touch-point-version` string
- `touch-point-sub-version` string
- `Accept-Language` string

## Request body

- InitiateInstallmentPlanRequest
  - `PlanData` PlanData
    - `NumberOfInstallments` integer
    - `Amount` MoneyWithCurrencyCode
      - `Value` number, required
      - `CurrencyCode` string
    - `FirstInstallmentAmount` MoneyWithCurrencyCode
      - `Value` number, required
      - `CurrencyCode` string
    - `RefOrderNumber` string
    - `TestMode` 'None' | 'Regular' | 'Fast' | 'Automation'
    - `PurchaseMethod` 'InStore' | 'PhoneOrder' | 'ECommerce' | 'Moto' | 'InStoreVcc' | 'ECommerceVcc'
    - `Strategy` 'SecuredPlan' | 'NonSecuredPlan' | 'SecuredPlanCaptureExistingSecurityAuth' | 'SecuredPlan3' | 'SinglePayment' | 'ExternalInstallmentProvider' | 'SecuredPlan3A' | 'SecuredPlan3B' | 'SecuredPlan2A' | 'SecuredPlan2' | 'SecuredPlan4' | 'SecuredPlan4A' | 'SecuredPlan5' | 'SecuredPlan6' | 'SecuredPlan7' | 'SecuredPlan10'
    - `ExtendedParams` object
    - `FirstChargeDate` string, date-time
    - `AutoCapture` boolean
    - `IsFunded` boolean
    - `ExternalProviderSupported` boolean, required
    - `Attempt3DSecure` boolean
  - `ConsumerData` ConsumerData
    - `Id` string
    - `UniqueId` string
    - `UserName` string
    - `FullName` string
    - `Email` string
    - `PhoneNumber` string
    - `CultureName` string
    - `IsLocked` boolean, required
    - `IsDataRestricted` boolean, required
    - `IsDataPrivateRestricted` boolean, required
  - `BillingAddress` AddressData
    - `AddressLine` string
    - `AddressLine2` string
    - `City` string
    - `Country` string
    - `State` string
    - `Zip` string
    - `FullAddressLine` string
  - `InstallmentPlanNumber` string
  - `PaymentWizardData` PaymentWizardData
    - `RequestedNumberOfInstallments` string
    - `SuccessExitURL` string
    - `ErrorExitURL` string
    - `CancelExitURL` string
    - `SuccessAsyncUrl` string
    - `ViewName` string
    - `IsOpenedInIframe` boolean, required
    - `Is3dSecureInPopup` boolean
    - `PaymentFormMessage` string
    - `SetShortUrl` boolean, required
  - `RedirectUrls` RedirectUrls
    - `Succeeded` string
    - `Canceled` string
    - `Failed` string
  - `EventsEndpoints` EventsEndpoints
    - `CreateSucceeded` string
  - `CreditCardDetails` CardData
    - `CardId` string
    - `CardNumber` string
    - `CardExpMonth` string
    - `CardExpYear` string
    - `CardBrand` ReferenceEntity
      - `Id` integer, required
      - `Code` string
      - `Description` string
    - `CardType` ReferenceEntity
      - `Id` integer, required
      - `Code` string
      - `Description` string
    - `Bin` string
    - `CardHolderFullName` string
    - `CardCvv` string
    - `Address` AddressData
      - `AddressLine` string
      - `AddressLine2` string
      - `City` string
      - `Country` string
      - `State` string
      - `Zip` string
      - `FullAddressLine` string
    - `Token` string
  - `ResponseElements` ResponseElements
    - `DisplaySchedules` boolean, required

## Response `200`

OK

## Other responses

- `400` — Bad Request

---

[API](https://skmtc.net/splitit/apis/splitit-web-api-public.md) · [All operations](https://skmtc.net/splitit/apis/splitit-web-api-public/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/splitit/splitit-web-api-public/revisions/f056ade263a0/schema)