Skip to main content

Initiate Installment Plan

POST 
/initiate

Initiate establishes an installment plan but doesn't finalize it, and is thus intended for use with Splitit premade checkout solutions such as Payment Forms or Flex Form. Initiate only requires SAQ-A certification. You can call it multiple times for the same installment plan, since each time a new API call is made, existing data will be updated and new values will be appended to the existing plan. Note that for funded plans, a customer's BillingAddress object must be filled out.

Request​

Header Parameters

    X-Splitit-TestMode string
    X-Splitit-IdempotencyKey string

Body

    AutoCapturebooleanrequired

    Indicates whether to capture the first installment automatically when creating the plan, or to wait for explicit indication to do the first capture (the default is true)

    Attempt3dSecureboolean

    Indicates whether to run a 3D secure verification (default is false)

    Shopper

    object

    FullNamestring
    Emailstring
    PhoneNumberstring
    Culturestring

    PlanData

    object

    required

    TotalAmountdecimal

    The total order amount

    Currencystringrequired
    NumberOfInstallmentsint32

    When populated will be used to display as default in Payment Form

    TerminalIdstringrequired

    The merchant terminal identifier

    PurchaseMethodstring

    How purchase was made (default is ECommerce)

    Possible values: [InStore, PhoneOrder, ECommerce]

    RefOrderNumberstring

    Reference order number for merchant's use

    ExtendedParams

    object

    Additional data that can be added as key/value pair parameters by merchant (and later can be retrieved by GET)

    property name*string
    FirstInstallmentAmountdecimal
    FirstInstallmentDatedate-time

    BillingAddress

    object

    AddressLine1string
    AddressLine2string
    Citystring
    Countrystring

    ISO 3166-3 code

    Statestring

    ISO 3166-2 code

    Zipstring

    RedirectUrls

    object

    Used for 3DS redirection back to success or failure page

    Succeededstring
    Failedstring
    Cancelstring

    UxSettings

    object

    DisplayedInstallmentOptionsint32[]

    EventsEndpoints

    object

    CreateSucceededstring

Responses​

Success

Schema

    InstallmentPlanNumberstring
    RefOrderNumberstring
    PurchaseMethodstring

    How purchase was made (default is ECommerce)

    Possible values: [InStore, PhoneOrder, ECommerce]

    Statusstringrequired

    Possible values: [Initialized, PendingCapture, Active, Cleared, Canceled]

    Currencystring
    Amountdecimal

    ExtendedParams

    object

    property name*string

    Shopper

    object

    FullNamestring
    Emailstringrequired
    PhoneNumberstring
    Culturestring

    BillingAddress

    object

    AddressLinestring
    AddressLine2string
    Citystring
    Countrystring

    ISO 3166 Country name OR 2-character code OR 3-character code

    Statestring

    ISO 3166-2 State

    Zipstring
    CheckoutUrlstring